params: Parameter Descriptions for pgfeatureserv Functions

paramsR Documentation

Parameter Descriptions for pgfeatureserv Functions

Description

Parameter Descriptions for pgfeatureserv Functions

Arguments

...

Unused parameters.

response

A flag indicating whether to return the raw response object.

base_url

A character string of the base URL.

path

A character string of the path or endpoint.

user

A character string of the user. This allows whoever is running the server your are querying to contact you in case of misuse.

verbose

A flag indicating whether to provide verbose GET response.

collection_id

A character string of the collection id.

feature_id

A positive whole number of the feature id.

function_id

A character string of the function 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.

nocache

A character string indicating whether to cache results or not. Possible values include 'true' or 'false' or NULL.

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)).

precision

A positive whole number indicating precision (i.e., number of decimal places) of GeoJSON coordinates.

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.

parameters

A named list of the parameters and values for a specific function.


poissonconsulting/pgfsr documentation built on Nov. 4, 2024, 4:02 p.m.