diff --git a/R/GSODR.R b/R/GSODR.R new file mode 100644 index 00000000..e2c48683 --- /dev/null +++ b/R/GSODR.R @@ -0,0 +1,24 @@ +#' GSODR: Global Surface Summary Daily Weather Data in R. +#' +#'The GSODR package is an R package that provides a function that +#'automates downloading and cleaning data from the "Global Surface +#'Summary of the Day (GSOD)" weather station data provided by the US National +#'Climatic Data Center (NCDC). Station files are individually checked for number +#'of missing days to assure data quality, stations with too many missing +#'observations are omitted. All units are converted to International System of +#'Units (SI), e.g., inches to millimetres and Fahrenheit to Celsius. Output is +#'saved as a Comma Separated Value (CSV) file or in a spatial GeoPackage +#'(GPKG) file, implemented by most major GIS software, summarising each +#'year by station, which also includes vapour pressure and relative +#'humidity variables calculated from existing data in GSOD. +#' +#' @section GSODR functions: +#' \code{\link{get_GSOD}} +#' +#' \code{\link{nearest_stations}} +#' +#' @section References: +#' \url{https://data.noaa.gov/dataset/global-surface-summary-of-the-day-gsod} +#' @docType package +#' @name GSODR +NULL diff --git a/man/GSODR.Rd b/man/GSODR.Rd new file mode 100644 index 00000000..7d69123b --- /dev/null +++ b/man/GSODR.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/GSODR.R +\docType{package} +\name{GSODR} +\alias{GSODR} +\alias{GSODR-package} +\title{GSODR: Global Surface Summary Daily Weather Data in R.} +\description{ +The GSODR package is an R package that provides a function that +automates downloading and cleaning data from the "Global Surface +Summary of the Day (GSOD)" weather station data provided by the US National +Climatic Data Center (NCDC). Station files are individually checked for number +of missing days to assure data quality, stations with too many missing +observations are omitted. All units are converted to International System of +Units (SI), e.g., inches to millimetres and Fahrenheit to Celsius. Output is +saved as a Comma Separated Value (CSV) file or in a spatial GeoPackage +(GPKG) file, implemented by most major GIS software, summarising each +year by station, which also includes vapour pressure and relative +humidity variables calculated from existing data in GSOD. +} +\section{GSODR functions}{ + +\code{\link{get_GSOD}} + +\code{\link{nearest_stations}} +} + +\section{References}{ + +\url{https://data.noaa.gov/dataset/global-surface-summary-of-the-day-gsod} +} +