### cache_dir() example with output

Source: https://docs.ropensci.org/weathercan/reference/cache_dir.html

Example call to cache_dir() showing the default cache directory path.

```r
cache_dir()
#> [1] "~/.local/share/weathercan"
```

--------------------------------

### Example: stations_meta() with check_eccc()

Source: https://docs.ropensci.org/weathercan/reference/stations_meta.html

Example usage of stations_meta() wrapped in a check_eccc() call, which is only run when the check_eccc() condition is true. The example is wrapped in an if (FALSE) block, indicating it is not run by default.

```r
if (FALSE) { # check_eccc()
stations_meta()
}
```

--------------------------------

### normals_file example output

Source: https://docs.ropensci.org/weathercan/reference/normals_file.html

Example call to normals_file() and its output, showing the expected file path for the cached normals data.

```r
normals_file()
#> [1] "~/.local/share/weathercan/1991-2020_Canadian_Climate_Normals_CANADA_Data.csv"
```

--------------------------------

### stations_search() examples

Source: https://docs.ropensci.org/weathercan/reference/stations_search.html

Example calls to stations_search() demonstrating name searches, interval filtering, year range restrictions, normals_years options, and coordinate-based search. The examples are wrapped in if (FALSE) { # check_eccc() } to prevent execution during package checks.

```r
if (FALSE) { # check_eccc()

stations_search(name = "Kamloops")
stations_search(name = "Kamloops", interval = "hour")

stations_search(name = "Ottawa", starts_latest = 1950, ends_earliest = 2010)

stations_search(name = "Ottawa", normals_years = "current")   # 1981-2010
stations_search(name = "Ottawa", normals_years = "1981-2010") # Same as above
stations_search(name = "Ottawa", normals_years = "1971-2000") # 1971-2010

if(requireNamespace("sf")) {
  stations_search(coords = c(53.915495, -122.739379))
}
}
```

--------------------------------

### Install weathercan from r-Universe

Source: https://docs.ropensci.org/weathercan/index.html

Install the weathercan package from the rOpenSci r-Universe repository. Use this before loading the package for the first time.

```r
install.packages(
  "weathercan",
  repos = c("https://ropensci.r-universe.dev", "https://cloud.r-project.org")
)
```

--------------------------------

### Example: Interpolate weather data for finch observations

Source: https://docs.ropensci.org/weathercan/reference/weather_interp.html

Example from the documentation (wrapped in if (FALSE) to avoid execution). It shows how to align timezones between finch observation times and weather data, then calls weather_interp to interpolate weather for the first 30 observations. The example assumes data frames 'kamloops' and 'finches' are already loaded.

```r
if (FALSE) { # check_eccc()

# Weather data only
kamloops

# Data about finch observations at RFID feeders in Kamloops, BC
finches

# Match weather to finches

# First line up the timezones
# - Finches are in Pacific Time (inc. Daylight savings),
#   Kamloops is in Pacific Time *without* daylight savings, but is marked as UTC for
#   simplicity (see ?weather_dl for details)
# - First we convert finches to remove daylight savings, then we mark as UTC
finches <- dplyr::mutate(finches, time = lubridate::with_tz(time, "Etc/GMT+8"))
finches <- dplyr::mutate(finches, time = lubridate::force_tz(time, "UTC"))

# Then interpolate over the first 30 observations
finch_weather <- weather_interp(data = finches[1:30,], weather = kamloops)
}
```

--------------------------------

### weather_dl and stations_search example

Source: https://docs.ropensci.org/weathercan/reference/weather_dl.html

Example R code wrapped in if (FALSE) to prevent execution. It downloads weather data for Kamloops and Prince George, searches for stations, and plots temperature over time. Also shows downloading only January and December data using the months parameter.

```R
if (FALSE) { # check_eccc()

kam <- weather_dl(station_ids = 51423,
                  start = "2016-01-01", end = "2016-02-15")

stations_search("Kamloops A$", interval = "hour")
stations_search("Prince George Airport", interval = "hour")

kam.pg <- weather_dl(station_ids = c(48248, 51423),
                     start = "2016-01-01", end = "2016-02-15")

library(ggplot2)

ggplot(data = kam.pg, aes(x = time, y = temp,
                          group = station_name,
                          colour = station_name)) +
       geom_line()

# Download only January and December
kam <- weather_dl(
  station_ids = 51423,
  start = "2016-01-01",
  end = "2018-02-15",
  months = c(1, 10)
)
}

```

--------------------------------

### Example output of check_eccc() returning FALSE

Source: https://docs.ropensci.org/weathercan/reference/check_eccc.html

Example output of check_eccc() when the checks fail, returning FALSE.

```r
check_eccc()
#> [1] FALSE
```

--------------------------------

### Sample output of stations()

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Example tibble output from stations() showing station metadata columns such as prov, station_name, station_id, and normals flags.

```r
## # A tibble: 6 × 17
##   prov  station_name        station_id climate_id WMO_id TC_id   lat   lon  elev tz        interval start   end normals normals_1991_2020 normals_1981_2010
##   <chr> <chr>                    <dbl> <chr>       <dbl> <chr> <dbl> <dbl> <dbl> <chr>     <fct>    <dbl> <dbl> <lgl>   <lgl>             <lgl>            
## 1 AB    DAYSLAND                  1795 301AR54        NA <NA>   52.9 -112.  689. Etc/GMT+7 hour        NA    NA FALSE   FALSE             FALSE            
## 2 AB    DAYSLAND                  1795 301AR54        NA <NA>   52.9 -112.  689. Etc/GMT+7 day       1908  1922 FALSE   FALSE             FALSE            
## 3 AB    DAYSLAND                  1795 301AR54        NA <NA>   52.9 -112.  689. Etc/GMT+7 month     1908  1922 FALSE   FALSE             FALSE            
## 4 AB    EDMONTON CORONATION       1796 301BK03        NA <NA>   53.6 -114.  671. Etc/GMT+7 hour        NA    NA FALSE   FALSE             FALSE            
```

--------------------------------

### Load required packages for downloading normals

Source: https://docs.ropensci.org/weathercan/articles/normals.html

Loads weathercan for downloading data, tidyr for unnesting, dplyr for data manipulation, and naniar for exploring missing values. This setup is needed before using normals_dl() and stations_search().

```R
library(weathercan)
library(tidyr)
library(dplyr)
library(naniar) # For exploring missing values
```

--------------------------------

### Output of head(stations())

Source: https://docs.ropensci.org/weathercan/index.html

Example output from head(stations()) showing the first six rows of the station data frame. The output includes columns such as prov, station_name, station_id, climate_id, and interval.

```r
## # A tibble: 6 × 17
##   prov  station_name        station_id climate_id WMO_id TC_id   lat   lon  elev tz        interval start   end normals normals_1991_2020 normals_1981_2010
##   <chr> <chr>                    <dbl> <chr>       <dbl> <chr> <dbl> <dbl> <dbl> <chr>     <fct>    <dbl> <dbl> <lgl>   <lgl>             <lgl>            
## 1 AB    DAYSLAND                  1795 301AR54        NA <NA>   52.9 -112.  689. Etc/GMT+7 hour        NA    NA FALSE   FALSE             FALSE            
## 2 AB    DAYSLAND                  1795 301AR54        NA <NA>   52.9 -112.  689. Etc/GMT+7 day       1908  1922 FALSE   FALSE             FALSE            
## 3 AB    DAYSLAND                  1795 301AR54        NA <NA>   52.9 -112.  689. Etc/GMT+7 month     1908  1922 FALSE   FALSE             FALSE            
## 4 AB    EDMONTON CORONATION       1796 301BK03        NA <NA>   53.6 -114.  671. Etc/GMT+7 hour        NA    NA FALSE   FALSE             FALSE            
## 5 AB    EDMONTON CORONATION       1796 301BK03        NA <NA>   53.6 -114.  671. Etc/GMT+7 day       1978  1979 FALSE   FALSE             FALSE            
## 6 AB    EDMONTON CORONATION       1796 301BK03        NA <NA>   53.6 -114.  671. Etc/GMT+7 month     1978  1979 FALSE   FALSE             FALSE            
## # ℹ 1 more variable: normals_1971_2000 <lgl>
```

--------------------------------

### Download multiple stations weather with weather_dl()

Source: https://docs.ropensci.org/weathercan/index.html

Downloads weather data for multiple stations at once by passing a vector of station IDs to `weather_dl()`. The example uses stations 48248 and 51423 for the same date range.

```r
kam_pg <- weather_dl(
  station_ids = c(48248, 51423),
  start = "2018-02-01",
  end = "2018-04-15"
)
```

--------------------------------

### Download multiple climate IDs for composite stations

Source: https://docs.ropensci.org/weathercan/reference/normals_dl.html

Download climate normals for multiple climate IDs that form a composite station (e.g., for 1990-2010 normals). The example shows how to view the composite_stations column.

```R
stations_search("Winnipeg", normals_years = "current")
n <- normals_dl(climate_ids = c("502S001", "5023227", "5023222"))
unique(dplyr::select(n, "location_name", "composite_stations"))
```

--------------------------------

### Load required libraries for weathercan

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Loads dplyr, ggplot2, and weathercan packages needed for the examples in this article.

```r
library(dplyr)
library(ggplot2)
library(weathercan)
```

--------------------------------

### cache_remove() example in interactive session

Source: https://docs.ropensci.org/weathercan/reference/cache_remove.html

Example usage of cache_remove() wrapped in an if (FALSE) block to prevent execution during package checks. It is intended for interactive use.

```r
if (FALSE) { # interactive()
cache_remove()
}
```

--------------------------------

### Terminal notice for weathercan program

Source: https://docs.ropensci.org/weathercan/LICENSE.html

Output this notice when the program starts in interactive mode. It includes the copyright line and warranty/redistribution conditions, with commands 'show w' and 'show c' to display the relevant license parts.

```plaintext
weathercan Copyright (C) 2019 Steffi LaZerte
This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type 'show c' for details.

```

--------------------------------

### Download 1981-2010 normals for a climate ID

Source: https://docs.ropensci.org/weathercan/articles/normals.html

Use normals_dl with climate_ids and normals_years to download normals data for a specific station. The example downloads normals for climate ID 5023222 and assigns the result to n.

```R
n <- normals_dl(climate_ids = "5023222", normals_years = "1981-2010")
n
```

--------------------------------

### stations()

Source: https://docs.ropensci.org/weathercan/reference/stations.html

Returns the built-in stations data frame containing station metadata from Environment and Climate Change Canada. The data frame includes columns for province, station name, station ID, climate ID, WMO ID, TC ID, latitude, longitude, elevation, timezone, interval, start and end years, and climate normals availability.

```APIDOC
## stations()

### Description
Returns the built-in stations data frame containing station metadata from Environment and Climate Change Canada. The data frame includes columns for province, station name, station ID, climate ID, WMO ID, TC ID, latitude, longitude, elevation, timezone, interval, start and end years, and climate normals availability.

### Usage
```r
stations()
```

### Format
A data frame with the following columns:
- **prov** (character) - Province
- **station_name** (character) - Station name
- **station_id** (numeric) - Environment Canada's station ID number. Required for downloading station data.
- **climate_id** (character) - Climate ID number
- **WMO_id** (character) - Climate ID number
- **TC_id** (character) - Climate ID number
- **lat** (numeric) - Latitude of station location in degree decimal format
- **lon** (numeric) - Longitude of station location in degree decimal format
- **elev** (numeric) - Elevation of station location in metres
- **tz** (character) - Local timezone excluding any Daylight Savings
- **interval** (character) - Interval of the data measurements ('hour', 'day', 'month')
- **start** (numeric) - Starting year of data record
- **end** (numeric) - Ending year of data record
- **normals** (logical) - Whether _any_ climate normals are available for that station (new behaviour)
- **normals_1991_2020** (logical) - Whether 1991-2020 climate normals are available for that station. **Note** that even if available, these are not yet downloadable via weathercan.
- **normals_1981_2010** (logical) - Whether 1981-2010 climate normals are available for that station
- **normals_1971_2000** (logical) - Whether 1971-2000 climate normals are available for that station

### Details
You can check when this was last updated with `stations_meta()`. A dataset containing station information downloaded from Environment and Climate Change Canada. Note that a station may have several station IDs, depending on how the data collection has changed over the years. Station information can be updated by running `stations_dl()`.

### Examples
```r
if (FALSE) { # check_eccc()
stations()
stations_meta()

# Which Manitoba stations have *any* climate normals?
# Note `normals` is TRUE or FALSE, so we can included it as is for normals == TRUE

library(dplyr)
filter(stations(), interval == "hour", normals, prov == "MB")
}
```
```

--------------------------------

### Download weather data with weather_dl()

Source: https://docs.ropensci.org/weathercan/articles/tidyhydat.html

Downloads daily weather data for station 50821 (Brandon) for the date range specified by dates[1] and dates[2]. The interval is set to 'day'.

```R
rain <- weather_dl(
  station_ids = 50821,
  interval = "day",
  start = dates[1],
  end = dates[2]
)
```

--------------------------------

### cache_dir() usage

Source: https://docs.ropensci.org/weathercan/reference/cache_dir.html

Usage of the cache_dir() function to get the cache directory path.

```r
cache_dir()
```

--------------------------------

### Reproducibility workflow with weathercan

Source: https://docs.ropensci.org/weathercan/articles/reproducibility.html

Run this R code to download weather data and then capture the stations metadata, package citation, and session info for reproducibility. Requires the devtools package for session_info().

```R
# Work
library(weathercan)
s <- stations_search("Winnipeg", normals_years = "current")
w <- weather_dl(s, interval = "month", start = "2021-01-01")

# Reproducibility
stations_meta()
citation('weathercan')
devtools::session_info() # Install devtools if you don't have it
```

--------------------------------

### Download weather data with weather_dl()

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Downloads weather data for station 51423 from 2016-01-01 to 2016-02-15.

```r
kam <- weather_dl(station_ids = 51423, start = "2016-01-01", end = "2016-02-15")
```

--------------------------------

### Load required packages

Source: https://docs.ropensci.org/weathercan/articles/tidyhydat.html

Loads weathercan, tidyhydat, and supporting packages (dplyr, ggplot2, lubridate, glue) for the workflow.

```r
library(weathercan)
library(tidyhydat)

library(dplyr)
library(ggplot2)
library(lubridate)
library(glue)
```

--------------------------------

### Download single station weather with weather_dl()

Source: https://docs.ropensci.org/weathercan/index.html

Downloads weather data for a single station using `weather_dl()`. The output includes a message about time display (shown once per session) and a tibble with 1,776 rows and 38 columns, including station metadata and hourly observations.

```r
kam <- weather_dl(station_ids = 51423, start = "2018-02-01", end = "2018-04-15")
```

```r
## As of weathercan v0.3.0 time display is either local time or UTC See Details under `weather_dl()` (`?weather_dl()`) for more information. This message is shown
## once per session
```

```r
kam
```

```r
## # A tibble: 1,776 × 38
##    station_name station_id station_operator prov    lat   lon  elev climate_id WMO_id TC_id date       time                 year month   day hour   qual   temp
##    <chr>             <dbl> <chr>            <chr> <dbl> <dbl> <dbl> <chr>      <chr>  <chr> <date>     <dttm>              <dbl> <int> <int> <time> <chr> <dbl>
##  1 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 00:00:00  2018     2     1 00:00  <NA>    0.2
##  2 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 01:00:00  2018     2     1 01:00  <NA>   -0.8
##  3 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 02:00:00  2018     2     1 02:00  <NA>   -0.4
##  4 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 03:00:00  2018     2     1 03:00  <NA>   -0.7
##  5 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 04:00:00  2018     2     1 04:00  <NA>   -1  
##  6 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 05:00:00  2018     2     1 05:00  <NA>   -1  
##  7 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 06:00:00  2018     2     1 06:00  <NA>   -1  
##  8 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 07:00:00  2018     2     1 07:00  <NA>   -0.9
##  9 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 08:00:00  2018     2     1 08:00  <NA>   -0.9
## 10 KAMLOOPS A        51423 NAV Canada       BC     50.7 -120.  345. 1163781    71887  YKA   2018-02-01 2018-02-01 09:00:00  2018     2     1 09:00  <NA>   -0.7
## # ℹ 1,766 more rows
```

--------------------------------

### devtools::session_info() output

Source: https://docs.ropensci.org/weathercan/articles/reproducibility.html

Session information including R version, operating system, and package versions, useful for documenting the environment.

```R
## ─ Session info ──────────────────────────────────────────────────────────────────────────────
##  setting  value
##  version  R version 4.6.0 (2026-04-24)
##  os       Ubuntu 24.04.4 LTS
##  system   x86_64, linux-gnu
##  ui       Positron
##  language en_CA:en_US:en
##  collate  en_US.UTF-8
##  ctype    en_US.UTF-8
##  tz       America/Winnipeg
##  date     2026-06-16
##  pandoc   3.8.3 @ /usr/share/positron/resources/app/quarto/bin/tools/x86_64/ (via rmarkdown)
##  quarto   1.6.39 @ /opt/quarto/bin/quarto
## 
## ─ Packages ──────────────────────────────────────────────────────────────────────────────────
##  package         * version date (UTC) lib source
##  allcontributors   0.2.3   2026-04-02 [1] CRAN (R 4.6.0)
##  askpass           1.2.1   2024-10-04 [1] CRAN (R 4.6.0)
##  bit               4.6.0   2025-03-06 [1] CRAN (R 4.6.0)
##  bit64             4.8.2   2026-05-19 [1] CRAN (R 4.6.0)
##  blob              1.3.0   2026-01-14 [1] CRAN (R 4.6.0)
##  cachem            1.1.0   2024-05-16 [1] CRAN (R 4.6.0)
##  callr             3.7.6   2024-03-25 [1] CRAN (R 4.6.0)
##  cli               3.6.6   2026-04-09 [1] CRAN (R 4.6.0)
##  crayon            1.5.3   2024-06-20 [1] CRAN (R 4.6.0)
##  credentials       2.0.3   2025-09-12 [1] CRAN (R 4.6.0)
##  curl              7.1.0   2026-04-22 [1] CRAN (R 4.6.0)
##  DBI               1.3.0   2026-02-25 [1] CRAN (R 4.6.0)
##  dbplyr            2.5.2   2026-02-13 [1] CRAN (R 4.6.0)
##  devtools          2.5.2   2026-04-30 [1] CRAN (R 4.6.0)
##  digest            0.6.39  2025-11-19 [1] CRAN (R 4.6.0)
##  dplyr           * 1.2.1   2026-04-03 [1] CRAN (R 4.6.0)
##  ellipsis          0.3.3   2026-04-04 [1] CRAN (R 4.6.0)
##  evaluate          1.0.5   2025-08-27 [1] CRAN (R 4.6.0)
##  farver            2.1.2   2024-05-13 [1] CRAN (R 4.6.0)
##  fastmap           1.2.0   2024-05-15 [1] CRAN (R 4.6.0)
##  fs                2.1.0   2026-04-18 [1] CRAN (R 4.6.0)
##  generics          0.1.4   2025-05-09 [1] CRAN (R 4.6.0)
##  gert              2.3.1   2026-01-11 [1] CRAN (R 4.6.0)
##  ggplot2         * 4.0.3   2026-04-22 [1] CRAN (R 4.6.0)
##  gh                1.5.0   2025-05-26 [1] CRAN (R 4.6.0)
##  gitcreds          0.1.2   2022-09-08 [1] CRAN (R 4.6.0)
##  glue            * 1.8.1   2026-04-17 [1] CRAN (R 4.6.0)
##  gtable            0.3.6   2024-10-25 [1] CRAN (R 4.6.0)
##  hms               1.1.4   2025-10-17 [1] CRAN (R 4.6.0)
##  htmltools         0.5.9   2025-12-04 [1] CRAN (R 4.6.0)
##  httr2             1.2.2   2025-12-08 [1] CRAN (R 4.6.0)
##  jsonlite          2.0.0   2025-03-27 [1] CRAN (R 4.6.0)
##  knitr           * 1.51    2025-12-20 [1] CRAN (R 4.6.0)
##  labeling          0.4.3   2023-08-29 [1] CRAN (R 4.6.0)
##  lifecycle         1.0.5   2026-01-08 [1] CRAN (R 4.6.0)
##  lubridate       * 1.9.5   2026-02-04 [1] CRAN (R 4.6.0)
##  magrittr          2.0.5   2026-04-04 [1] CRAN (R 4.6.0)
##  memoise           2.0.1   2021-11-26 [1] CRAN (R 4.6.0)
```

--------------------------------

### Filter stations with dplyr filter()

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Uses dplyr's filter() on stations() output to select BC stations with hourly interval, latitude between 49 and 49.5, longitude between -119 and -116, and start <= 2002 and end >= 2016.

```r
BCstations <- stations() |>
  filter(prov %in% c("BC")) |>
  filter(interval == "hour") |>
  filter(lat > 49 & lat < 49.5) |>
  filter(lon > -119 & lon < -116) |>
  filter(start <= 2002) |>
  filter(end >= 2016)
BCstations
```

--------------------------------

### Get unique measurement types from normals_measurement_types

Source: https://docs.ropensci.org/weathercan/articles/normals.html

Returns the unique values of the measurement_type column from the normals_measurement_types data frame. The output shows four measurement types: Temperature, Precipitation, Days with Maximum Temperature, and Days with Minimum Temperature.

```r
unique(normals_measurement_types$measurement_type)
```

--------------------------------

### weather_dl(station_ids, start, end, interval, months, trim, trim_by_stn, format, string_as, time_disp, encoding, list_col)

Source: https://docs.ropensci.org/weathercan/reference/weather_dl.html

Downloads weather data from Environment and Climate Change Canada (ECCC) for one or more stations. This function allows specifying station IDs, date range, interval, and various formatting options.

```APIDOC
## weather_dl(station_ids, start, end, interval, months, trim, trim_by_stn, format, string_as, time_disp, encoding, list_col)

### Description
Downloads data from Environment and Climate Change Canada (ECCC) for one or more stations. For details and units, see the glossary vignette (`vignette("glossary", package = "weathercan")`) or the glossary online https://climate.weather.gc.ca/glossary_e.html.

### Usage
```r
weather_dl(
  station_ids,
  start = NULL,
  end = NULL,
  interval = "hour",
  months = NULL,
  trim = TRUE,
  trim_by_stn = FALSE,
  format = TRUE,
  string_as = NA,
  time_disp = "none",
  encoding = "UTF-8",
  list_col = FALSE
)
```

### Arguments
- **station_ids** (Numeric/Character) - Required - A vector containing the ID(s) of the station(s) you wish to download data from. See the `stations` data frame or the `stations_search` function to find IDs.
- **start** (Date/Character) - Optional - The start date of the data in YYYY-MM-DD format (applies to all stations_ids). Defaults to start of range.
- **end** (Date/Character) - Optional - The end date of the data in YYYY-MM-DD format (applies to all station_ids). Defaults to end of range.
- **interval** (Character) - Optional - Interval of the data, one of "hour", "day", "month".
- **months** (Numeric vector) - Optional - Can supply 1-12 to optionally filter the data to only specific months. For "hour" interval, this selectively downloads data by month so can speed up downloads. For intervals of "day" and "month" this only filters the data after full years or full data ranges have been downloaded.
- **trim** (Logical) - Optional - Trim missing values from the start and end of the weather dataframe. Only applies if `format = TRUE`.
- **trim_by_stn** (Logical) - Optional - Data from different stations are generally padded with NAs to have the same date range. If this isn't desirable, use `trim = TRUE` and `trim_by_stn = TRUE` to trim `NA`s from the start and end of each station. `trim_by_stn = FALSE` (default), only the sides of the entire range are trimmed.
- **format** (Logical) - Optional - If TRUE, formats data for immediate use. If FALSE, returns data exactly as downloaded from Environment and Climate Change Canada. Useful for dealing with changes by Environment Canada to the format of data downloads.
- **string_as** (Character) - Optional - What value to replace character strings in a numeric measurement with. See Details.
- **time_disp** (Character) - Optional - Either "none" (default) or "UTC". See details.
- **encoding** (Character) - Optional - Text encoding for download.
- **list_col** (Logical) - Optional - Return data as nested data set? Defaults to FALSE. Only applies if `format = TRUE`.

### Details
For details and units, see the glossary vignette (`vignette("glossary", package = "weathercan")`) or the glossary online https://climate.weather.gc.ca/glossary_e.html.

```

--------------------------------

### Update stations data frame with stations_dl()

Source: https://docs.ropensci.org/weathercan/reference/stations_dl.html

Downloads the latest station inventory and then uses the updated data frame in stations_search(). Wrapped in if (FALSE) because it requires an internet connection and may take a few minutes.

```r
if (FALSE) { # check_eccc()

# Update stations data frame
stations_dl()

# Updated stations data frame is now automatically used
stations_search("Winnipeg")
}
```

--------------------------------

### weather_dl()

Source: https://docs.ropensci.org/weathercan/reference/index.html

Downloads weather data from Environment and Climate Change Canada.

```APIDOC
## weather_dl()

### Description
Downloads weather data from Environment and Climate Change Canada.

### Usage
weather_dl()

### Value
Downloaded weather data.
```

--------------------------------

### glimpse(stations()) - View all station data

Source: https://docs.ropensci.org/weathercan/index.html

Inspect the full stations data frame returned by stations() with glimpse(). The output shows 26,448 rows and 17 columns including station metadata, coordinates, time zone, interval, and normals flags.

```r
glimpse(stations())
```

```r
## Rows: 26,448
## Columns: 17
## $ prov              <chr> "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", "AB", …
## $ station_name      <chr> "DAYSLAND", "DAYSLAND", "DAYSLAND", "EDMONTON CORONATION", "EDMONTON CORONATION", "EDMONTON CORONATION", "FLEET", "FLEET", "FLEET", …
## $ station_id        <dbl> 1795, 1795, 1795, 1796, 1796, 1796, 1797, 1797, 1797, 1798, 1798, 1798, 1799, 1799, 1799, 1800, 1800, 1800, 1801, 1801, 1801, 1802, …
## $ climate_id        <chr> "301AR54", "301AR54", "301AR54", "301BK03", "301BK03", "301BK03", "301B6L0", "301B6L0", "301B6L0", "301B8LR", "301B8LR", "301B8LR", …
## $ WMO_id            <dbl> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, …
## $ TC_id             <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, …
## $ lat               <dbl> 52.87, 52.87, 52.87, 53.57, 53.57, 53.57, 52.15, 52.15, 52.15, 53.20, 53.20, 53.20, 52.40, 52.40, 52.40, 54.08, 54.08, 54.08, 53.52,…
## $ lon               <dbl> -112.28, -112.28, -112.28, -113.57, -113.57, -113.57, -111.73, -111.73, -111.73, -110.15, -110.15, -110.15, -115.20, -115.20, -115.2…
## $ elev              <dbl> 688.8, 688.8, 688.8, 670.6, 670.6, 670.6, 838.2, 838.2, 838.2, 640.0, 640.0, 640.0, 1036.0, 1036.0, 1036.0, 585.2, 585.2, 585.2, 668…
## $ tz                <chr> "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "Etc/GMT+7", "E…
## $ interval          <fct> hour, day, month, hour, day, month, hour, day, month, hour, day, month, hour, day, month, hour, day, month, hour, day, month, hour, …
## $ start             <dbl> NA, 1908, 1908, NA, 1978, 1978, NA, 1987, 1987, NA, 1987, 1987, NA, 1980, 1980, NA, 1980, 1980, NA, 1986, 1986, NA, 1987, 1987, NA, …
## $ end               <dbl> NA, 1922, 1922, NA, 1979, 1979, NA, 1990, 1990, NA, 1998, 1998, NA, 2009, 2007, NA, 1981, 1981, NA, 2019, 2007, NA, 1991, 1991, NA, …
## $ normals           <lgl> FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, TRUE, TRUE, TRUE, FALSE, FALSE, FALSE, TRUE, TRU…
## $ normals_1991_2020 <lgl> FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE,…
## $ normals_1981_2010 <lgl> FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, TRUE, TRUE, TRUE, FALSE, FALSE, FALSE, TRUE, TRU…
## $ normals_1971_2000 <lgl> FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE,…
```

--------------------------------

### normals_dl()

Source: https://docs.ropensci.org/weathercan/reference/index.html

Downloads climate normals from Environment and Climate Change Canada.

```APIDOC
## normals_dl()

### Description
Downloads climate normals from Environment and Climate Change Canada.

### Usage
normals_dl()

### Value
Downloaded climate normals data.
```

--------------------------------

### Download climate normals with normals_dl()

Source: https://docs.ropensci.org/weathercan/articles/normals.html

Calls normals_dl() with climate_ids = "5023222" to download climate normals for the Winnipeg Richardson (Airport) station. Requires a climate_id, not station_id. If no cache folder exists, weathercan prompts to create one.

```R
n <- normals_dl(climate_ids = "5023222")
```

--------------------------------

### View station data with stations()

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Displays the first rows of the stations data frame returned by stations(). The output shows station metadata including province, station name, ID, climate ID, coordinates, timezone, interval, and normals flags.

```R
stations()
```

--------------------------------

### stations()

Source: https://docs.ropensci.org/weathercan/reference/index.html

Accesses station data downloaded from Environment and Climate Change Canada.

```APIDOC
## stations()

### Description
Accesses station data downloaded from Environment and Climate Change Canada.

### Usage
stations()

### Value
Station data frame.
```

--------------------------------

### stations_dl()

Source: https://docs.ropensci.org/weathercan/reference/index.html

Downloads available station data from Environment and Climate Change Canada.

```APIDOC
## stations_dl()

### Description
Downloads available station data from Environment and Climate Change Canada.

### Usage
stations_dl()

### Value
Downloaded station data.
```

--------------------------------

### Load required packages

Source: https://docs.ropensci.org/weathercan/articles/interpolate_data.html

Load the required packages for the interpolation workflow: weathercan for data access, ggplot2 for plotting, and dplyr for data manipulation.

```r
library(weathercan)
library(ggplot2)
library(dplyr)
```

--------------------------------

### citation('weathercan') output

Source: https://docs.ropensci.org/weathercan/articles/reproducibility.html

Citation information for weathercan, including the recommended citation and BibTeX entry for LaTeX users.

```R
## To cite 'weathercan' in publications, please use:
## 
##   LaZerte, Stefanie E and Sam Albers (2018). weathercan: Download and format weather
##   data from Environment and Climate Change Canada. The Journal of Open Source
##   Software 3(22):571. doi:10.21105/joss.00571.
## 
## A BibTeX entry for LaTeX users is
## 
##   @Article{,
##     title = {{weathercan}: {D}ownload and format weather data from Environment and Climate Change Canada},
##     author = {Stefanie E LaZerte and Sam Albers},
##     journal = {The Journal of Open Source Software},
##     volume = {3},
##     number = {22},
##     pages = {571},
##     year = {2018},
##     url = {https://joss.theoj.org/papers/10.21105/joss.00571},
##   }
```

--------------------------------

### Download multiple climate IDs for different locations

Source: https://docs.ropensci.org/weathercan/reference/normals_dl.html

Download climate normals for multiple climate IDs that are not composite stations, and view the unique locations.

```R
n <- normals_dl(climate_ids = c("5010480", "5023222"))
unique(dplyr::select(n, "location_name", "composite_stations"))
```

--------------------------------

### Update station list with stations_dl()

Source: https://docs.ropensci.org/weathercan/index.html

Updates the local station list with `stations_dl()`. The output shows the Environment Canada modified date and disclaimers, and notes that the data is saved for access via `stations()` and `stations_meta()`.

```r
stations_dl()
```

```r
## According to Environment Canada, Modified Date: 2026-06-03 23:30 UTC
## Environment Canada Disclaimers: "Station Inventory Disclaimer: Please note that this inventory list is a snapshot of stations on our website as of the modified
## date, and may be subject to change without notice." "Station ID Disclaimer: Station IDs are an internal index numbering system and may be subject to change
## without notice."
## Stations data saved... Use `stations()` to access most recent version and `stations_meta()` to see when this was last updated
```

--------------------------------

### Download weather data for multiple stations with weather_dl

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Downloads weather data for stations 48248 and 51423 from 2016-01-01 to 2016-02-15. The result is stored in kam.pg and can be viewed by printing the object.

```r
kam.pg <- weather_dl(
  station_ids = c(48248, 51423),
  start = "2016-01-01",
  end = "2016-02-15"
)

kam.pg
```

--------------------------------

### Download current climate normals (1991-2020)

Source: https://docs.ropensci.org/weathercan/reference/normals_dl.html

Download climate normals for a single climate ID using normals_dl with default normals_years ("current"). The result is stored in n and printed.

```R
n <- normals_dl(climate_ids = "5010480")
n
```

--------------------------------

### Download HYDAT data

Source: https://docs.ropensci.org/weathercan/articles/tidyhydat.html

Downloads and caches HYDAT data locally. This can take a while.

```r
download_hydat()
```

--------------------------------

### Update station list with stations_dl()

Source: https://docs.ropensci.org/weathercan/articles/weathercan.html

Updates the list of stations by downloading the latest station metadata from Environment Canada.

```r
stations_dl()
```

--------------------------------

### Display downloaded normals object

Source: https://docs.ropensci.org/weathercan/articles/normals.html

Prints the object n to display the downloaded climate normals data.

```R
n
```