fun_doc_code.R

#' Cleaning and Analyzing Air Quality Data
#'
#' This script cleans and analyzes air quality data, including calculating average
#' solar radiation for each month, determining correlations between Ozone and Solar
#' Radiation for each month, saving plots for each month, and saving cleaned data.
#'
#' @import ggplot2
#' @import dplyr
#'
#' @param data The air quality data frame to be cleaned and analyzed.
#'
#' @return None (The script performs operations and saves results to files.)
#'
#' @examples
#' # Load the libraries and run the script with the provided data
#' library(ggplot2)
#' library(dplyr)
#' source("script.R")
#'
#' @export
#'

# Loading necessary libraries
library(ggplot2)
library(dplyr)

# Fetching data
data <- airquality

# Data Cleaning - Remove rows with NA
cleaned_data <- data %>% 
  na.omit()

#' Function to calculate average solar radiation for each month
#'
#' @param month The month for which to calculate the average solar radiation.
#' @param data The cleaned data frame.
#'
#' @return The average solar radiation for the specified month.
#'
calculate_average_solar <- function(month, data) {
  avg_solar <- data %>%
    filter(Month == month) %>%
    summarise(avg_solar = mean(Solar.R)) %>%
    pull()
  return(avg_solar)
}

#' Function to calculate correlation between Ozone and Solar Radiation for each month
#'
#' @param month The month for which to calculate the correlation.
#' @param data The cleaned data frame.
#'
#' @return The correlation between Ozone and Solar Radiation for the specified month.
#'
calculate_correlation <- function(month, data) {
  correlation <- cor(data$Ozone[data$Month == month], data$Solar.R[data$Month == month])
  return(correlation)
}

# Calculating average and print to console
months <- c(5, 6, 7, 8, 9)
for (month in months) {
  avg_solar <- calculate_average_solar(month, cleaned_data)
  print(paste("Average Solar Radiation for Month", month, ": ", avg_solar))
}

# Calculating correlation and print to console
for (month in months) {
  correlation <- calculate_correlation(month, cleaned_data)
  print(paste("Correlation for Month", month, ": ", correlation))
}

#' Function to save plots
#'
#' @param month The month for which to save the plot.
#' @param data The cleaned data frame.
#'
#' @return None (The function saves the plot to a file.)
#'
save_plots <- function(month, data) {
  plot_data <- data[data$Month == month, ]
  g <- ggplot(plot_data, aes(x = Solar.R, y = Ozone)) + geom_point(aes(shape = factor(Month))) + ggtitle(month.name(month))
  ggsave(paste("plot_", tolower(month.name(month)), ".png", sep = ""), g)
}

# Save Plots
for (month in months) {
  save_plots(month, cleaned_data)
}

# Save data
write.csv(cleaned_data, "cleaned_data.csv", row.names = FALSE)