buildPopulation {IFC}

IFC Population Coercion

Description

Helper to build a list to allow population export.

Usage

buildPopulation(
  name,
  type,
  base = "All",
  color,
  lightModeColor,
  style,
  region,
  fx,
  fy,
  definition,
  obj,
  ...
)

Arguments

name

name of the population.

type

type of population. Either "B", "C", "G" or "T" for Base, Combined, Graphical or Tagged, respectively.
If missing, the default, 'type' will be deduced from other parameters. If 'name' is "All" type will be "B". Otherwise, if 'fx' is given type will be "G". Otherwise, "T", if 'definition' is missing but not 'obj' or "C" if 'definition' is not missing.

base

which population is based on. It will be base="All", for 'type' "T" and "C" and base="", for 'type' "B". It is only needed when type = "G".

color

color of the population. See paletteIFC for allowed colors. If not provided, it will be sampled.

lightModeColor

lightModeColor of the population. See paletteIFC for allowed colors. If not provided, it will be sampled.

style

style of the population. Either 20, 4, 3, 1, 5, 0, 2, 18, 15, 17, respectively for: "Simple Dot", "Cross", "Plus", "Empty Circle", "Empty Diamond", "Empty Square", "Empty Triangle", "Solid Diamond", "Solid Square", "Solid Triangle".

region

Only if type="G". Name of the region defining the population.

fx

Only needed if type="G". Name of the x-feature defining the population.

fy

Only needed if type="G" and only if region is defined in 2D. Name of the y-feature defining the population.

definition

Only needed if type="C". Parameters defining the population.

obj

Only needed if type="T". Either a:
-Logical vector of same length as "All" population indicating if a cell belongs to the population or not.
-Integer vector of indices of cells that belongs to the population. Note that first object is 0.

...

Other arguments to be passed.

Value

a list containing all population information.