internal: Parameter Descriptions
In poissonconsulting/fwapgr: Client for BC Freshwater Atlas fwapg API

internal

R Documentation

Parameter Descriptions

Description

Descriptions of the parameters and a typical return value for the provided functions.

Arguments

`bbox`	A vector of four numbers indicating bounding box to limit output features to, e.g. `c(minLon, minLat, maxLon, maxLat)`.
`blue_line_key`	A positive whole number of the stream blue line key.
`collection_id`	A character string of the collection id.
`downstream_route_measure`	A positive number of the river metre.
`end_measure`	An integer of the distance in meters upstream from the river mouth to end at.
`epsg`	A positive whole number of the epsg to transform features to.
`function_id`	A character string of the function id.
`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")`.
`interval_length`	An integer of the interval distance in meters.
`limit`	A positive whole number indicating the maximum number of features to return.
`offset`	A positive whole number indicating the offset of start of returned results.
`parameters`	A named list of the parameters and values for a specific function.
`properties`	A vector of strings of the column names to include. If NULL (default), all columns are retained.
`sortby`	A string that sorts the response items by a property. Default is ascending but property name can be prepended with '-' to indicate descending.
`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.
`srid`	A positive whole number of the epsg of the coordinates.
`start_measure`	An integer of the distance in meters upstream from the river mouth to start from.
`tolerance`	A number of the tolerance in m.
`transform`	A character vector with the name of the valid transform function followed by the parameter values (e.g. c("ST_Simplify", 100))
`x`	A number of the x coordinate.
`y`	A number of the y coordinate.
`nocache`	A flag specifying whether or not to cache results.