aims_filter_values: Retrieve vector of existing filter values

In open-AIMS/dataaimsr: AIMS Data Platform API Client

Retrieve vector of existing filter values

Description

This is a utility function which allows to user to query about the existing possibilities of a given filter name

Usage

aims_filter_values(target, filter_name)

Arguments

target	A character vector of length 1 specifying the dataset. Only weather or temp_loggers are currently allowed.
filter_name	A character string containing the name of the filter. Must be "site", "subsite", "series", or "parameter". See details.

Details

For a full description of each valid filter_name see ?aims_expose_attributes. In the temperature logger dataset, "subsite" is equivalent to "series"; moreover, note that there is only one parameter being measured (i.e. water temperature), so the "parameter" filter contains one single value.

Value

Either a data.frame if filter_name = "series", else a character vector.

Author(s)

AIMS Datacentre [e-mail]

See Also

aims_data, aims_expose_attributes

Examples

## Not run: 
library(dataaimsr)
aims_filter_values("weather", filter_name = "site")
aims_filter_values("temp_loggers", filter_name = "subsite")

## End(Not run)

open-AIMS/dataaimsr documentation built on July 1, 2023, 11:45 p.m.