From 2182ccd03d41bef170cd2c37b8e2e45de000a884 Mon Sep 17 00:00:00 2001 From: Kim Cressman Date: Thu, 11 Jul 2024 16:27:31 -0500 Subject: [PATCH] added links to data object-generating R scripts to the objects' documentation --- R/catch_pixels.R | 2 ++ R/catch_precip.R | 4 ++-- R/entero_stationdata.R | 4 ++-- R/enterodata.R | 4 ++-- man/catch_pixels.Rd | 3 +++ man/catch_precip.Rd | 4 ++-- man/entero_stationdata.Rd | 4 ++-- man/enterodata.Rd | 4 ++-- 8 files changed, 17 insertions(+), 12 deletions(-) diff --git a/R/catch_pixels.R b/R/catch_pixels.R index e348d42a..66e48d59 100644 --- a/R/catch_pixels.R +++ b/R/catch_pixels.R @@ -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" diff --git a/R/catch_precip.R b/R/catch_precip.R index b2fc3eb1..704bcdf7 100644 --- a/R/catch_precip.R +++ b/R/catch_precip.R @@ -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" diff --git a/R/entero_stationdata.R b/R/entero_stationdata.R index 7d453322..5290aa6c 100644 --- a/R/entero_stationdata.R +++ b/R/entero_stationdata.R @@ -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" diff --git a/R/enterodata.R b/R/enterodata.R index 72d27165..f7dcc688 100644 --- a/R/enterodata.R +++ b/R/enterodata.R @@ -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" diff --git a/man/catch_pixels.Rd b/man/catch_pixels.Rd index 5b4fd3ff..82463044 100644 --- a/man/catch_pixels.Rd +++ b/man/catch_pixels.Rd @@ -17,4 +17,7 @@ catch_pixels \description{ Catchments and radar pixels (for precip) of selected Enterococcus stations } +\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}) +} \keyword{datasets} diff --git a/man/catch_precip.Rd b/man/catch_precip.Rd index 1e443dc8..28af5357 100644 --- a/man/catch_precip.Rd +++ b/man/catch_precip.Rd @@ -13,7 +13,7 @@ A data frame with three columns: } } \source{ -Southwest Florida Management District radar-estimated daily rainfall data, ftp://ftp.swfwmd.state.fl.us/pub/radar_rainfall/Daily_Data/ +Southwest Florida Management District radar-estimated daily rainfall data, \url{ftp://ftp.swfwmd.state.fl.us/pub/radar_rainfall/Daily_Data/} } \usage{ catch_precip @@ -22,6 +22,6 @@ catch_precip Daily precip by catchment for selected Enterococcus stations } \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. +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}) } \keyword{datasets} diff --git a/man/entero_stationdata.Rd b/man/entero_stationdata.Rd index 1b30b3cb..34d0fac2 100644 --- a/man/entero_stationdata.Rd +++ b/man/entero_stationdata.Rd @@ -15,7 +15,7 @@ A data frame with 50 rows and 5 columns: } } \source{ -Lat/Long information from Water Quality Portal, https://waterqualitydata.us +Lat/Long information from Water Quality Portal, \url{https://waterqualitydata.us} } \usage{ entero_stationdata @@ -24,6 +24,6 @@ entero_stationdata Enterococcus station location metadata } \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}) +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}) } \keyword{datasets} diff --git a/man/enterodata.Rd b/man/enterodata.Rd index b49ad123..0390c024 100644 --- a/man/enterodata.Rd +++ b/man/enterodata.Rd @@ -22,7 +22,7 @@ A data frame with 413 rows and 12 columns: } } \source{ -Water Quality Portal, https://waterqualitydata.us +Water Quality Portal, \url{https://waterqualitydata.us} } \usage{ enterodata @@ -31,6 +31,6 @@ enterodata Enterococcus data from 5 stations over 5 years } \details{ -A sample dataset containing Enterococcus from 5 stations in the TBEP watershed from 2019-2023, for use in function examples. +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}) } \keyword{datasets}