More doc updates

Author: steffilazerte

R/weather_stn.R

@@ -1,3 +1,14 @@
+#' Prepare stations data for weather download
+#'
+#' Filters stations by station IDs and interval, converts start/end to dates.
+#'
+#' @param station_ids Character/Numeric vector. Station IDs to prepare
+#' @param interval Character. "hour", "day", or "month"
+#'
+#' @returns Tibble of prepared stations data with date ranges
+#'
+#' @noRd
+
 prep_stations <- function(station_ids, interval) {
   stn <- stations_read() |>
     dplyr::filter(
@@ -25,6 +36,21 @@ prep_stations <- function(station_ids, interval) {
   stn
 }
 
+#' Prepare start and end dates for weather download
+#'
+#' Processes start and end dates for each station, handling NULL values,
+#' date limits, and detecting invalid date ranges.
+#'
+#' @param stn Data frame. Prepared stations data
+#' @param start Date. Requested start date for download or NULL for earliest
+#'   available
+#' @param end Date. Requested end date for download or NULL for today
+#'
+#' @returns Tibble of stations data with start_use, end_use, and labels for
+#'   later messages
+#'
+#' @noRd
+
 prep_start_end <- function(stn, start, end) {
   # Check start/ends
   min_dt <- as.Date("1840-01-01") # Earliest date API will return
@@ -52,6 +78,18 @@ prep_start_end <- function(stn, start, end) {
   stn
 }
 
+#' Prepare pagination for weather download
+#'
+#' Creates sequences of dates for paginated API requests based on interval
+#' (hourly by month, daily by year, monthly downloads full dataset).
+#'
+#' @param stn Data frame. Stations data with start_use and end_use dates
+#' @param months Numeric vector. Optional months to filter for hourly data
+#'
+#' @returns Tibble of stations data with pages column containing date sequences
+#'
+#' @noRd
+
 prep_paging <- function(stn, months) {
   stn |>
     dplyr::mutate(

R/weathercan-package.R

@@ -1,6 +1,6 @@
 #' Easy downloading of weather data from Environment and Climate Change Canada
 #'
-#' \code{weathercan} is an R package for simplifying the downloading of
+#' `weathercan` is an R package for simplifying the downloading of
 #' Historical Climate Data from the Environment and Climate Change Canada (ECCC)
 #' website (<https://climate.weather.gc.ca>)
 #'
@@ -33,14 +33,14 @@
 #'  - [`kamloops_day`]
 #'  - [`pg`]
 #'
-#' As well as several vignettes available in the package and [Online](https://docs.ropensci.org/weathercan/):
+#' As well as several articles available [Online](https://docs.ropensci.org/weathercan/):
 #'
-#'  - [General Usage](https://docs.ropensci.org/weathercan/articles/weathercan.html): `vignette("weathercan", package = "weathercan")`
-#'  - [Interpolating](https://docs.ropensci.org/weathercan/articles/interpolate_data.html): `vignette("interpolation", package = "weathercan")`
-#'  - [Reproducibility](https://docs.ropensci.org/weathercan/articles/reproducibility.html): `vignette("reproducibility", package = "weathercan")`
-#'  - [Flags and Codes](https://docs.ropensci.org/weathercan/articles/flags.html): `vignette("flags", package = "weathercan")`
-#'  - [Weather: Terms and Units](https://docs.ropensci.org/weathercan/articles/glossary.html): `vignette("glossary", package = "weathercan")`
-#'  - [Climate Normals: Terms and Units](https://docs.ropensci.org/weathercan/articles/glossary_normals.html): `vignette("glossary_normals", package = "weathercan")`
+#'  - [General Usage](https://docs.ropensci.org/weathercan/articles/weathercan.html)
+#'  - [Interpolating](https://docs.ropensci.org/weathercan/articles/interpolate_data.html)
+#'  - [Reproducibility](https://docs.ropensci.org/weathercan/articles/reproducibility.html)
+#'  - [Flags and Codes](https://docs.ropensci.org/weathercan/articles/flags.html)
+#'  - [Weather: Terms and Units](https://docs.ropensci.org/weathercan/articles/glossary.html)
+#'  - [Climate Normals: Terms and Units](https://docs.ropensci.org/weathercan/articles/glossary_normals.html)
 #'
 #' We also have some advanced articles:
 #'