Skip to content

Commit

Permalink
feat!: no longer query lat/lon of stations by default
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed Jan 20, 2025
1 parent 5bffa8d commit 18d586e
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 9 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Suggests:
xts
Config/testthat/edition: 3
Encoding: UTF-8
RoxygenNote: 7.3.2
RoxygenNote: 7.3.2.9000
6 changes: 5 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

* Breaking change: `date_start` and `station` no longer have default values.

* New arguments `data`, `latlon`, `report_type`, `elev` (#49, @JElchison).
* New arguments `data`, `latlon`, `report_type`, `elev` (#48, @JElchison).

* Breaking change: `laton` default to `FALSE`: you need to explicitly set it to
`TRUE` for the latitude and longitude of the station
to be included in the output.

# riem 0.3.2

Expand Down
8 changes: 5 additions & 3 deletions R/measures.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@
#' Default value is `all`.
#' @param elev If TRUE, the elevation (m) of the station will be included in the output, in an `elevation` column. # nolint: line_length_linter
#' Default value is `FALSE`.
#' @param latlon If TRUE, the latitude and longitude of the station will be included in the output, in `lat` and `lon` columns. # nolint: line_length_linter
#' Default value is `TRUE`.
#' @param latlon Default to `FALSE` since riem 1.0.0. If `TRUE`,
#' the latitude and longitude of the station will be included in the output,
#' in `lat` and `lon` columns. # nolint: line_length_linter
#' Default value is `FALSE`.
#' @param report_type A vector of strings, representing report types to query.
#' The available options are `"hfmetar"`, `"routine"`, `"specials"`.
#' Default value is `c("routine", "specials")`.
Expand Down Expand Up @@ -80,7 +82,7 @@ riem_measures <- function(
date_end = as.character(Sys.Date()),
data = "all",
elev = FALSE,
latlon = TRUE,
latlon = FALSE,
report_type = NULL) {
# validate 'station' arg
if (!rlang::is_character(station, n = 1L)) {
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ pak::pak("ropensci/riem")

Please refer to the [`pkgdown` website](https://docs.ropensci.org/riem/) to read docs, in particular the [reference](https://docs.ropensci.org/riem/reference/index.html) and the [vignettes](https://docs.ropensci.org/riem/articles/index.html).

# Breaking change in riem 1.0.0

The `laton` argument of `riem_measures()` default to `FALSE`:
you need to explicitly set it to `TRUE` for the latitude and longitude of the station to be included in the output.

# Use cases in the wild

Submit your use cases by opening [a new issue](https://github.com/ropensci/riem/issues/new)!
Expand Down
10 changes: 6 additions & 4 deletions man/riem_measures.Rd

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

0 comments on commit 18d586e

Please sign in to comment.