Skip to content

Commit

Permalink
added links to data object-generating R scripts to the objects' docum…
Browse files Browse the repository at this point in the history
…entation
  • Loading branch information
swmpkim committed Jul 11, 2024
1 parent 156fa5e commit 2182ccd
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 12 deletions.
2 changes: 2 additions & 0 deletions R/catch_pixels.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,7 @@
#' \item{station}{a character string of the Water Quality Portal station name}
#' \item{pixel}{a number; each row is a single pixel from the Southwest Florida Water Management District's radar-estimated rainfall shapefile}
#' }
#'
#' @details Generated by \code{data-raw/catch_pixels-raw.R} (view on github: \url{https://github.com/tbep-tech/tbeptools/blob/master/data-raw/catch_pixels.R})

"catch_pixels"
4 changes: 2 additions & 2 deletions R/catch_precip.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
#' \item{rain}{a number; inches of rain for that date, averaged across all pixels in the station's catchment}
#' }
#' @details
#' Daily precipitation data from 1995-2023, provided by the Southwest Florida Water Management District, were downloaded at the pixel level and averaged to the catchment level for key Enterococcus sampling stations.
#' @source Southwest Florida Management District radar-estimated daily rainfall data, ftp://ftp.swfwmd.state.fl.us/pub/radar_rainfall/Daily_Data/
#' Daily precipitation data from 1995-2023, provided by the Southwest Florida Water Management District, were downloaded at the pixel level and averaged to the catchment level for key Enterococcus sampling stations. Generated by \code{data-raw/catch_precip-raw.R} (view on github: \url{https://github.com/tbep-tech/tbeptools/blob/master/data-raw/catch_precip-raw.R})
#' @source Southwest Florida Management District radar-estimated daily rainfall data, \url{ftp://ftp.swfwmd.state.fl.us/pub/radar_rainfall/Daily_Data/}
#'

"catch_precip"
4 changes: 2 additions & 2 deletions R/entero_stationdata.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
#' \item{bay_segment}{character, full name of Bay Segment in which the station lies}
#' \item{bay_segment_abbrev}{character, abbreviated version of Bay Segment in which the station lies}
#' }
#' @details Latitude, Longitude, and Bay Segment information for each of the identified key Enterococcus stations. Generated by \code{data-raw/entero_stationdata-raw.R} ( \link[https://github.com/tbep-tech/tbeptools/blob/master/data-raw/bsmap-raw.R]{view on github})
#' @details Latitude, Longitude, and Bay Segment information for each of the identified key Enterococcus stations. Generated by \code{data-raw/entero_stationdata-raw.R} (view on github: \url{https://github.com/tbep-tech/tbeptools/blob/master/data-raw/entero_stationdata-raw.R})
#'
#' @source Lat/Long information from Water Quality Portal, https://waterqualitydata.us
#' @source Lat/Long information from Water Quality Portal, \url{https://waterqualitydata.us}
#'

"entero_stationdata"
4 changes: 2 additions & 2 deletions R/enterodata.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
#' \item{mo}{numeric month of sample date}
#' }
#' @details
#' A sample dataset containing Enterococcus from 5 stations in the TBEP watershed from 2019-2023, for use in function examples.
#' @source Water Quality Portal, https://waterqualitydata.us
#' A sample dataset containing Enterococcus from 5 stations in the TBEP watershed from 2019-2023, for use in function examples. Generated by \code{data-raw/enterodata-raw.R} (view on github: \url{https://github.com/tbep-tech/tbeptools/blob/master/data-raw/enterodata-raw.R})
#' @source Water Quality Portal, \url{https://waterqualitydata.us}
#'

"enterodata"
3 changes: 3 additions & 0 deletions man/catch_pixels.Rd

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

4 changes: 2 additions & 2 deletions man/catch_precip.Rd

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

4 changes: 2 additions & 2 deletions man/entero_stationdata.Rd

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

4 changes: 2 additions & 2 deletions man/enterodata.Rd

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

0 comments on commit 2182ccd

Please sign in to comment.