mvdf_obj: Construct a Minimum Viable Data Frame object

Description Usage Arguments

View source: R/mvdf_class.R

Description

Construct a Minimum Viable Data Frame object

Usage

1
2
3
4
5
6
7
8
9
mvdf_obj(
  data = NULL,
  x = "x",
  y = "y",
  z = "z",
  idx = "idx",
  metadata = NULL,
  appendix = NULL
)

Arguments

data

Optionally, a data frame containing all the data necessary to create a 'mvdf_obj'. If left 'NULL', then 'x', 'y', 'z', and 'idx' are interpreted as the values to use for each slot; if not 'NULL', 'x', 'y', 'z', and 'idx' are interpreted as the names of columns in 'data' containing the values for each slot.

x, y, z

Numeric: distance of the origin of the object from the origin of the grid system (the central point at 0, 0, 0) in meters in the given direction. Must have no 'NA', 'NULL', 'NaN', 'Inf', or '-Inf' values. If 'data' is not 'NULL', the names of columns in 'data' with values for the respective slot. Coordinates are assumed to be on a right-handed coordinate system with Z oriented as the natural "vertical" direction.

idx

Character: a unique identifier (or "index") for each object to be modeled. Must be unique with no 'NA' or 'NULL' values, but otherwise is not validated. If 'data' is not 'NULL', the names of columns in 'data' with values for the slot. If left 'NULL', a sequential index is generated.

metadata

Data frame: a table containing additional information on the objects to be modeled. Optional, but if this slot is used then the data frame must contain a column named 'idx' which should correspond to the 'idx' slot. Only the existence of this column is validated.

appendix

List: additional data produced in the generation of the object. Not validated; any additional outputs that don't map to modeled objects may be inserted here.


mikemahoney218/mvdf documentation built on May 7, 2021, 11:46 a.m.