Skip to content

Commit

Permalink
Add GSODR.R to create helpfile for package
Browse files Browse the repository at this point in the history
suggested by @jefferyhanson
  • Loading branch information
adamhsparks committed Oct 24, 2016
1 parent 0c75123 commit a404494
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
24 changes: 24 additions & 0 deletions R/GSODR.R
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions man/GSODR.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a404494

Please sign in to comment.