Function reference • vicinity

S3 Classes

vicinity_parameters() make_pt_vicinity_parameters() is_vicinity_parameters(): ready4 submodule class for tibble object that stores simulation structural parameters relating to the spatial environment.

vicinity_values() make_pt_vicinity_values() is_vicinity_values(): ready4 submodule class for tibble object that stores simulation parameter values for each iteration.

vicinity_abbreviations() make_pt_vicinity_abbreviations() is_vicinity_abbreviations(): ready4 submodule class for tibble object lookup table for spatial data abbreviations.

vicinity_processed() make_pt_vicinity_processed() is_vicinity_processed(): ready4 submodule class for tibble object lookup table of meta-data for spatial data packs (imported and pre-processed data).

vicinity_raw() make_pt_vicinity_raw() is_vicinity_raw(): ready4 submodule class for tibble object lookup table of metadata about raw (un-processed) spatial data to import.

vicinity_resolutions() make_pt_vicinity_resolutions() is_vicinity_resolutions(): ready4 submodule class for tibble object lookup table of the relative resolutions of different spatial objects.

vicinity_points() make_pt_vicinity_points() is_vicinity_points(): ready4 submodule class for tibble object lookup table of the longitude and latitude cordinates of sites of services / homes.

vicinity_templates() make_pt_vicinity_templates() is_vicinity_templates(): ready4 submodule class for tibble object lookup table for base file used in creation of certain spatial objects.

vicinity_identifiers() make_pt_vicinity_identifiers() is_vicinity_identifiers(): ready4 submodule class for tibble object lookup table of unique feature identifiers used for different spatial objects.

vicinity_mapes() make_pt_vicinity_mapes() is_vicinity_mapes(): ready4 submodule class for tibble object that stores spatial simulation parameters relating to Mean Absolute Prediction Errors.

S4 Classes

VicinityLookup-class VicinityLookup: VicinityLookup

VicinityMacro-class VicinityMacro: VicinityMacro

VicinityMesoRegion-class VicinityMesoRegion: VicinityMesoRegion

VicinityMesoArea-class VicinityMesoArea: VicinityMesoArea

VicinityMicro-class VicinityMicro: VicinityMicro

VicinityProfile-class VicinityProfile: VicinityProfile

VicinitySpaceTime-class VicinitySpaceTime: VicinitySpaceTime

VicinityArguments-class VicinityArguments: VicinityArguments

VicinityLocal-class VicinityLocal: VicinityLocal

VicinityLocalRaw-class VicinityLocalRaw: VicinityLocalRaw

VicinityLocalProcessed-class VicinityLocalProcessed: VicinityLocalProcessed

Methods

author.vicinity_processed() author(<vicinity_processed>) author.vicinity_raw() author(<vicinity_raw>) author(<VicinityLocalProcessed>) author(<VicinityLocalRaw>) author(<VicinityArguments>): Author and save files

authorData.vicinity_raw() authorData(<vicinity_raw>) authorData(<VicinityLocalRaw>): Author and document datasets

ingest.vicinity_processed() ingest(<vicinity_processed>) ingest.vicinity_raw() ingest(<vicinity_raw>) ingest(<VicinityProfile>): Ingest data

manufacture.vicinity_abbreviations() manufacture(<vicinity_abbreviations>) manufacture.vicinity_parameters() manufacture(<vicinity_parameters>) manufacture.vicinity_points() manufacture(<vicinity_points>) manufacture.vicinity_processed() manufacture(<vicinity_processed>) manufacture.vicinity_raw() manufacture(<vicinity_raw>) manufacture(<VicinityLookup>) manufacture(<VicinityProfile>): Manufacture a new object

metamorphose.vicinity_raw() metamorphose(<vicinity_raw>) metamorphose(<VicinityLocalProcessed>) metamorphose(<VicinityLocalRaw>): Metamorphose a ready4 model module to a ready4 model module of a different class

procure.vicinity_abbreviations() procure(<vicinity_abbreviations>) procure.vicinity_identifiers() procure(<vicinity_identifiers>) procure.vicinity_raw() procure(<vicinity_raw>) procure.vicinity_resolutions() procure(<vicinity_resolutions>) procure(<VicinityProfile>): Procure items from a dataset

ratify.vicinity_processed() ratify(<vicinity_processed>): Ratify that input or output data meet validity criteria

reckon.vicinity_mapes() reckon(<vicinity_mapes>) reckon.vicinity_parameters() reckon(<vicinity_parameters>): Reckon (calculate) a value

renew.vicinity_points() renew(<vicinity_points>) renew.vicinity_processed() renew(<vicinity_processed>) renew.vicinity_raw() renew(<vicinity_raw>) renew(<VicinityLookup>) renew(<VicinityArguments>): Renew (update) values