ALA4R (version 1.9.1)

search_layers: Search for environmental and contextual data layers

Description

Search for environmental and contextual data layers

Usage

search_layers(query, type = "all", output_format = "simple")

Arguments

query

text string: optional search term against layer metadata. Only layers that include this term in their metadata will be returned.

type

string: either "all" (all possible layers; default), "grids" (gridded environmental layers), or "shapes" (contextual shapefile layers)

output_format

string: controls the print method for the returned object. Either "complete" (the complete data structure is displayed), or "simple" (a simplified version is displayed). Note that the complete data structure exists in both cases: this option only controls what is displayed when the object is printed to the console. The default output format is "simple"

Value

A data frame of results. The contents (column names) of the data frame will vary depending on the details of the search and the results

References

Associated ALA web services: https://api.ala.org.au/#ws11 https://api.ala.org.au/#ws12 https://api.ala.org.au/#ws13

Descriptions of the spatial layers: https://spatial.ala.org.au/ws/layers/index/)

Examples

# NOT RUN {
search_layers(type = "all")
search_layers(type = "grids", query = "income")
search_layers(type = "shapes", query = "coral", output_format = "simple")
# }