filter_wastd_turtledata: Filter WAStD turtledata to an area_name

In dbca-wa/wastdr: WA Sea Turtle Database 'WAStD' API Wrapper

Filter WAStD turtledata to an area_name

Description

Filter WAStD turtledata to an area_name

Usage

filter_wastd_turtledata(
  x,
  area_name = NULL,
  seasons = NULL,
  verbose = wastdr::get_wastdr_verbose()
)

Arguments

x	An object of class wastd_data as returned by download_wastd_turtledata. This data can be filtered to an area_name (WAStD Area of type Locality).
area_name	(chr) The name of the area to filter the data by. Options: NULL (default): do not filter data, return unfiltered data. "All turtle programs": do not filter data, return unfiltered data. "Other": Filter data to area_name NA. Any name in unique(wastd_data$areas$area_name): return data filtered to this area_name.
seasons	(list of int) A list of seasons to filter the data by. NULL (default): return data from all seasons. list of numbers: return data from given seasons. E.g. c(2017L, 2018L, 2019L) or 2017:2019 returns data from seasons 2017-18 through to 2019-20.
verbose	Whether to show debug messages. Default: wastdr::get_wastdr_verbose()

Value

An object of class wastd_data filtered to records within area_name and the list of seasons.

See Also

Other api: build_auth(), download_minimal_wastd_turtledata(), download_wastd_sites(), download_wastd_turtledata(), download_wastd_users(), export_wastd_turtledata(), filter_wastd_turtledata_area(), filter_wastd_turtledata_seasons(), handle_http_status(), wastd_GET(), wastd_POST(), wastd_bulk_post(), wastd_chunk_post(), wastd_create_update_skip(), wastd_parse(), wastd_post_one()

Examples

## Not run: 
data(wastd_data)
first_area <- wastd_data$areas$area_name[[1]]
wastd_data_filtered <- wastd_data %>%
  filter_wastd_turtledata(area_name = first_area)
wastd_data
wastd_data_filtered
unique(wastd_data_filtered$areas$area_name)

## End(Not run)

dbca-wa/wastdr documentation built on Nov. 20, 2022, 12:25 p.m.