rflsgen (version 1.2.2)

flsgen_create_class_targets: Creates a set of targets for a landscape class

Description

Creates a set of targets for a landscape class, which can be converted into JSON for flsgen.

Usage

flsgen_create_class_targets(
  class_name,
  NP = NULL,
  AREA = NULL,
  AREA_MN = NULL,
  CA = NULL,
  PLAND = NULL,
  PD = NULL,
  SPI = NULL,
  LPI = NULL,
  MESH = NULL,
  SPLI = NULL,
  NPRO = NULL,
  SDEN = NULL,
  COHE = NULL,
  DIVI = NULL,
  IS_SQUARE = FALSE,
  ALL_DIFFERENT = FALSE
)

Value

A class targets object which can be converted to JSON for flsgen

Arguments

class_name

Name of the class

NP

number of patches target (must be a vector of length 2)

AREA

patch area target (must be a vector of length 2)

AREA_MN

mean patch area target (must be a vector of length 2)

CA

total class area target (must be a vector of length 2)

PLAND

proportion of landscape target (must be a vector of length 2)

PD

patch density target (must be a vector of length 2)

SPI

smallest patch index target (must be a vector of length 2)

LPI

largest patch index target (must be a vector of length 2)

MESH

effective mesh size target (must be a vector of length 2)

SPLI

splitting index target (must be a vector of length 2)

NPRO

net product target (must be a vector of length 2)

SDEN

splitting density target (must be a vector of length 2)

COHE

degree of coherence target (must be a vector of length 2)

DIVI

degree of landscape division target (must be a vector of length 2)

IS_SQUARE

if TRUE, the class is required to only produce square patches

ALL_DIFFERENT

if TRUE, the class is required to have differently sized patches

Details

Note that NP and AREA targets can be set as NULL, if the class targets is used within the `generate_series` function to generate landscape series with varying NP and/or AREA. However, flsgen won't run is NP and AREA are not set elsewhere.

Examples

  if (FALSE) {
    cls_1 <- flsgen_create_class_targets("class 1", NP=c(1, 10), AREA=c(0, 1000))
  }