plan_globals: Create a drake plan describing targets relating to global...

View source: R/plan_globals.R

plan_globalsR Documentation

Create a drake plan describing targets relating to global parameters

Description

Create a drake plan that describes targets relating to global parameters to be used by individual species plans.

Usage

plan_globals(
  clum_path,
  nvis_path,
  ndvi_path,
  fertiliser_data_path,
  nrm_path,
  containers_data_path,
  postcode_path,
  pop_density_path,
  tourist_beds_path,
  airports_path,
  airport_beta,
  airport_tsi_beta,
  basemap_mode = c("osm", "boundaries"),
  processed_data_path
)

Arguments

clum_path

Character. File path to Catchment Scale Land Use of Australia (ACLUM) raster.

nvis_path

Character. File path to the National Vegetation Information System (NVIS) raster dataset.

ndvi_path

Character. File path to the Normalised Difference Vegetation Index (NDVI) raster dataset.

fertiliser_data_path

Character. File path to a csv containing data describing fertiliser use.

nrm_path

Character. File path to shapefile of Natural Resource Management (NRM) Regions.

containers_data_path

Character. File path to xlsx file containing data about shipping container movements.

postcode_path

Character. File path to postal areas (i.e. post codes) shapefile.

pop_density_path

Character. File path to population density raster.

tourist_beds_path

Character. File path to tourist beds shapefile.

airports_path

Character. File path to major aviation terminals shapefile.

airport_beta

Numeric. Parameter controlling the distribution of tourists (international air passengers) around Australian international airports. Distance to nearest airport is multiplied by this value and exponentiated to give the relative density of tourists at a location. To generate a distribution that ensures proportion p of tourists within distance d of nearest airport, specify airport_beta=log(p)/d (e.g. to have 50% of tourists within 200 km of an airport, use log(0.5)/200).

airport_tsi_beta

Numeric. Interpretation is as for airport_beta, but applies to air passengers arriving at Cairns International Airport (CNS) from the Torres Strait Islands.

basemap_mode

Type of basemap for static maps. Either 'osm' (default), or 'boundaries' (polygons delineating borders of states/territories).

processed_data_path

Character. File path to directory for storing processed and intermediate datasets.

Details

Datasets used by this function are available in the edmaps data Australia repository.

Value

A drake plan containing targets that generate objects used across species.


jscamac/edmaps documentation built on June 11, 2022, 1:26 a.m.