ejformula: See formula(s) used for EJSCREEN variable(s)

View source: R/ejformula.R

ejformulaR Documentation

See formula(s) used for EJSCREEN variable(s)

Description

Just a convenient way to look at the formula(s) used to create one or more variables in EJSCREEN.

Usage

ejformula(fieldname = "all", decreasing = NA, dropNA = TRUE, recursive = FALSE)

Arguments

fieldname

Optional, character vector specifying variable(s) in ejscreenformulas$Rfieldname, default is all ejscreenformulas$Rfieldname that are not NA values.

decreasing

Optional, passed to sort except default is not sorted (just the order that exists in ejscreenformulas)

dropNA

Be careful: Optional, default is TRUE. If TRUE, returns only formulas that are not NA values. If FALSE, and decreasing is not specified (sorting drops NA values here), returns vector the same length as fieldname (unless recursive = TRUE)

recursive

Optional, default is FALSE. If TRUE, returns also returns formula(s) for variable(s) found on right hand side of formula(s), i.e. those used to create specified variable(s)

Value

Character vector of the formula(s) used to calculate the specified variable, in ejscreenformulas

See Also

ejscreenformulas

Examples

  ejformula('VSI.eo')
  ejformula(c('pctmin', 'pctlowinc'))
  ejformula('VSI.eo', recursive = TRUE)
  ejformula()

ejanalysis/ejscreen documentation built on April 2, 2024, 10:15 a.m.