survey: Surveys

Description Usage Arguments Details Value Supported text formats Supported schemas

View source: R/survey.R


survey is a constructor function that generates an instance of a survey object from an structured text document that collects spatially related observations.





Path to a structured text document in one of the supported formats.


A survey is a collection of spatially related observations or records that conform to a structure or schema (e.g. landholder-plot-neighbour) for which the settle package provides a suitable reader. A survey object is useful to explore spatial semantics within the collection in order to spatially aggreggate data, plot neighbouring items or identify and locate clusters.


A survey object or an error in case path is invalid or format/schema is not supported.

Supported text formats

Currently the only supported format is YAML.

Supported schemas

The only implemented reader is LPNschema_reader, which can parse documents with a landholder-plot-neighbour schema.

quommit/settle documentation built on May 26, 2019, 1:31 p.m.