pgf_function_description: Get function description

In poissonconsulting/pgfsr: Client for pg_featureserv RESTful web service

Get function description

Description

Get information on function description.

Usage

pgf_function_description(
  function_id,
  base_url,
  path,
  nocache = NULL,
  user = gh_user(),
  verbose = FALSE,
  response = FALSE
)

Arguments

function_id	A character string of the function id.
base_url	A character string of the base URL.
path	A character string of the path or endpoint.
nocache	A character string indicating whether to cache results or not. Possible values include 'true' or 'false' or NULL.
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.
response	A flag indicating whether to return the raw response object.

Value

A string.

See Also

Other functions: pgf_function_parameters(), pgf_function_properties(), pgf_function_result(), pgf_functions()

Examples

## Not run: 
function_id <- "fwa_locatealong"
base_url <- "https://features.hillcrestgeo.ca/"
path <- "fwa"
pgf_function_description(
  function_id = function_id, base_url = base_url, path = path
)

## End(Not run)

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