Skip to content

Commit

Permalink
adding include_definitions_id parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
lilyclements committed Jun 25, 2024
1 parent e117687 commit 7ae99a5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
5 changes: 3 additions & 2 deletions R/station_metadata.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
#' This function retrieves metadata for weather stations in specified countries.
#' @param country A character vector specifying the country or countries from which to get the metadata. Options include "zm" (Zambia) and "mz" (Mozambique).
#' @param station_id A character vector specifying the station IDs to filter by. If provided, only metadata for the specified station IDs will be returned.
#' @param include_definitions_id A logical value indicating whether to include the definitions ID.
#' @param include_definitions A logical value indicating whether to include definitions data. If TRUE, additional information about station definitions will be included in the output.
#' @param format A character vector specifying the format of the output. Options are "wide" (default), "long", "nested", or "list".
#' @return If `include_definitions` is FALSE, the function returns a data frame with metadata for the specified stations. If `include_definitions` is TRUE, it returns a data frame with both metadata and station definitions.
#'
#' @export
station_metadata <- function(country = NULL, station_id = NULL, include_definitions = FALSE, format = c("wide", "long", "nested", "list")) {
epicsadata::station_metadata(country = country, station_id = station_id, include_definitions = include_definitions, format = format)
station_metadata <- function(country = NULL, station_id = NULL, include_definitions_id = TRUE, include_definitions = FALSE, format = c("wide", "long", "nested", "list")) {
epicsadata::station_metadata(country = country, station_id = station_id, include_definitions_id = include_definitions_id, include_definitions = include_definitions, format = format)
}
3 changes: 3 additions & 0 deletions man/station_metadata.Rd

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

0 comments on commit 7ae99a5

Please sign in to comment.