params: Parameter Descriptions for pgfeatureserv Functions

In poissonconsulting/fishobspgr: Client for BC Fish Observation and Passage RESTful API

Parameter Descriptions for pgfeatureserv Functions

Description

Parameter Descriptions for pgfeatureserv Functions

Arguments

...	Unused parameters.
collection_id	A character string of the collection id.
limit	A positive whole number that limits the number of features in the response.
offset	A positive whole number that starts the response at an offset.
sortby	A string that sorts the response items by a property. Default is ascending but property name can be prepended with '-' to indicate descending.
bbox	A vector of four numbers indicating bounding box in lon/lat (e.g. c(minLon, minLat, maxLon, maxLat)) that features in response must intersect.
filter	A named vector or list of the filter(s) to apply, where the list names correspond to column names and the list values correspond to the desired value, e.g. list(gnis_name = "Sangan River").
properties	A vector of strings of the column names to include. If NULL (default), all columns are retained.
transform	A character vector with the name of the valid transform function followed by the parameter values (e.g. c("ST_Simplify", 100)).
groupby	A string of the property name (i.e., column name) to group response features by. This would typically be used with an aggregate transform function.

poissonconsulting/fishobspgr documentation built on Nov. 5, 2024, 4:37 a.m.