Skip to content

Commit

Permalink
Cleanup/Clarify documentation a bit more
Browse files Browse the repository at this point in the history
Move some of information from Description to Details

Replace comma-delimited with comma-separated
  • Loading branch information
adamhsparks committed May 27, 2016
1 parent 1e83aaa commit 0906faa
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 23 deletions.
37 changes: 20 additions & 17 deletions R/get_GSOD.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,6 @@
#'All units are converted to International System of Units (SI), e.g. Fahrenheit
#'to Celsius and inches to millimetres. For convenience elevation is
#'converted from decimetres to metres.
#'Due to the size of the resulting data, output is saved as a comma-delimited
#'csv file (default) or ESRI shapefile in a directory specified by the user or
#'defaults to the current working directory. The files summarize each year by
#'station, which includes vapour pressure and relative humidity variables
#'calculated from existing data in GSOD.
#'All missing values in resulting files are represented as -9999.99
#'regardless of which field they occur in.
#'Be sure to have disk space free and allocate the proper time for this to run.
#'This is a time, processor and disk input/output/space intensive process.
#'This function was largely based on T. Hengl's "getGSOD.R" script, available
#'from \url{http://spatial-analyst.net/book/system/files/getGSOD.R} with
#'enhancements to be more cross-platform, faster and a bit more flexible.
#'For more information see the description of the data provided by NCDC,
#'\url{http://www7.ncdc.noaa.gov/CDO/GSOD_DESC.txt}.
#'
#'
#' @param years Year(s) of weather data to download.
#' @param station Specify single station for which to retrieve, check and clean
Expand All @@ -48,8 +33,26 @@
#' defaults to TRUE, a CSV file is created.
#'
#'
#' @details This function generates a CSV or ESRI format shapefile in the
#' respective year-directory containing the following variables:
#' @details
#'Due to the size of the resulting data, output is saved as a comma-separated,
#'csv, file (default) or ESRI shapefile in a directory specified by the user or
#'defaults to the current working directory. The files summarize each year by
#'station, which includes vapour pressure and relative humidity variables
#'calculated from existing data in GSOD.
#'
#'All missing values in resulting files are represented as -9999.99
#'regardless of which field they occur in.
#'
#'Be sure to have disk space free and allocate the proper time for this to run.
#'This is a time, processor and disk input/output/space intensive process.
#'This function was largely based on T. Hengl's "getGSOD.R" script, available
#'from \url{http://spatial-analyst.net/book/system/files/getGSOD.R} with
#'enhancements to be more cross-platform, faster and a bit more flexible.
#'For more information see the description of the data provided by NCDC,
#'\url{http://www7.ncdc.noaa.gov/CDO/GSOD_DESC.txt}.
#'
#' The CSV or ESRI format shapefile in the respective year-directory
#' will contain the following fields/values:
#' \describe{
#' \item{STNID}{Station number (WMO/DATSAV3 number) for the location}
#' \item{WBAN}{Number where applicable--this is the historical "Weather Bureau
Expand Down
15 changes: 9 additions & 6 deletions man/get_GSOD.Rd

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

0 comments on commit 0906faa

Please sign in to comment.