diff --git a/.Rbuildignore b/.Rbuildignore index e543a5f..c6ce9f7 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,5 @@ ^LICENSE\.md$ ^README\.Rmd$ ^\.github$ +^.*\.Rproj$ +^\.Rproj\.user$ diff --git a/R/climatic_missing.R b/R/climatic_missing.R index 61beb53..89b4c45 100644 --- a/R/climatic_missing.R +++ b/R/climatic_missing.R @@ -14,19 +14,7 @@ #' @export #' #' @examples -#' # Example 1: Calculate missing data summary for all elements and stations -#' #summary_data <- climatic_missing(data = climatic_data, date = "Date") -#' -#' # Example 2: Calculate missing data summary for specific elements and stations -#' #summary_data <- climatic_missing(data = climatic_data, date = "Date", elements = c("Temperature", "Precipitation"), stations = c("Station1", "Station2")) -#' -#' # Example 3: Calculate missing data summary with custom start and end dates -#' #summary_data <- climatic_missing(data = climatic_data, date = "Date", start = FALSE, end = TRUE) -#' -#' # Example 4: Calculate missing data summary without including station information -#' #summary_data <- climatic_missing(data = climatic_data, date = "Date", stations = NULL) -#' -#' +#' # TODO climatic_missing <- function(data, date, elements = ..., stations, start = TRUE, end = FALSE){ if (missing(date)){ diff --git a/instatClimatic.Rproj b/instatClimatic.Rproj index 8e3c2eb..21a4da0 100644 --- a/instatClimatic.Rproj +++ b/instatClimatic.Rproj @@ -11,3 +11,7 @@ Encoding: UTF-8 RnwWeave: Sweave LaTeX: pdfLaTeX + +BuildType: Package +PackageUseDevtools: Yes +PackageInstallArgs: --no-multiarch --with-keep.source diff --git a/man/climatic_missing.Rd b/man/climatic_missing.Rd index e3bdba0..ec87c8d 100644 --- a/man/climatic_missing.Rd +++ b/man/climatic_missing.Rd @@ -33,17 +33,5 @@ A data frame containing the summary of missing data, including the start and end This function calculates the summary of missing data in climatic variables for different stations and elements within a specified time period. It provides information on the start and end dates of missing data, the total number of missing values, and the percentage of missing values for each station and element. Additionally, it counts the number of complete years (without any missing values) for each station and element. } \examples{ -# Example 1: Calculate missing data summary for all elements and stations -#summary_data <- climatic_missing(data = climatic_data, date = "Date") - -# Example 2: Calculate missing data summary for specific elements and stations -#summary_data <- climatic_missing(data = climatic_data, date = "Date", elements = c("Temperature", "Precipitation"), stations = c("Station1", "Station2")) - -# Example 3: Calculate missing data summary with custom start and end dates -#summary_data <- climatic_missing(data = climatic_data, date = "Date", start = FALSE, end = TRUE) - -# Example 4: Calculate missing data summary without including station information -#summary_data <- climatic_missing(data = climatic_data, date = "Date", stations = NULL) - - +# TODO } diff --git a/man/instatClimatic-package.Rd b/man/instatClimatic-package.Rd index c9ca978..5397af4 100644 --- a/man/instatClimatic-package.Rd +++ b/man/instatClimatic-package.Rd @@ -4,12 +4,19 @@ \name{instatClimatic-package} \alias{instatClimatic} \alias{instatClimatic-package} -\title{instatClimatic: What the Package Does (One Line, Title Case)} +\title{instatClimatic: A set of climatic functions used in R-Instat} \description{ -What the package does (one paragraph). +This package contains a set of climatic functions used in R-Instat. This includes functions written specifically for R-Instat, as well functions written elsewhere that are modified for use in R-Instat. } \author{ -\strong{Maintainer}: First Last \email{first.last@example.com} (\href{https://orcid.org/YOUR-ORCID-ID}{ORCID}) +\strong{Maintainer}: Lily Clements \email{lily@idems.international} (\href{https://orcid.org/0000-0001-8864-0552}{ORCID}) + +Authors: +\itemize{ + \item Danny Parsons + \item Antoine Ntalumeso + \item Stephen Lloyd +} } \keyword{internal}