available_sections: List of available sections for dawa()
Description
Simple function to list all available options for the section
parameter in dawa()
. Useful when getting to know the base api function of
this package. To filter based on funciton usage you can provide format = "geojson"
to ensure compatability with get_map_data()
and func = "get_data"
to ensure compatability with get_data()
.
Usage
available_sections(as_list = FALSE, format = NULL, verbose = TRUE, func = NULL)
Value
The function returns either a named list or an atomic vector with the
available sections in the API. The format is decided by as_list
.
Arguments
- as_list
This options controls the output format. The output is either
a named list or an atomic vector with the available sections
- format
Specify a format type. The function now returns only available
sections that can respond with that format. Currently geojson
is the only
format that is specified.
- verbose
whether or not to provide {cli}
output for the user. Enabled
by default, but disabled for all functions that wrap this function
- func
Sepcify the function you would like to ensure section
compatability with.
Examples
Run this code
available_sections()
available_sections(as_list = TRUE)
Run the code above in your browser using DataLab