fe_tally_list: User Friendly Construction of an *fe_tally_list* Object from...
View source: R/fe_tally_list.R
| fe_tally_list | R Documentation |
User Friendly Construction of an fe_tally_list Object from a List of Data Frames
Description
fe_tally_list() provides a user-friendly interface for the
constructor new_fe_tally_list. While the constructor does
not prevent users from creating malformed fe_tally_list objects,
fe_tally_list does everything to achieve a well-defined object
mostly based on an initial list of data.frames that might be, e.g. drawn out
of a user's own data base.
Usage
fe_tally_list(
x,
stand_id = "my_tally_list",
tree_count_name = "tree_count",
class_def_name = "class_definition",
area_ha_name = "area_ha",
size_class_col,
tree_nr_col,
species_id_col,
count_col,
class_type_col,
class_min_col,
class_max_col
)
Arguments
x |
named list of two or three data frames to be coerced into the goal object. One data frame must contain the tree counts data |
stand_id |
arbitrary id of the stand ( |
tree_count_name |
name of the data frame in |
class_def_name |
name of the column in the trees data frame which provides the definition of the counting classes (default: "class_definition") |
area_ha_name |
name of the column in the trees data frame which provides each tree's representation number per ha. |
size_class_col |
description |
tree_nr_col |
description |
species_id_col |
description |
count_col |
description |
class_type_col |
description |
class_min_col |
description |
class_max_col |
description |
Details
The input object x to fe_tally_list must be a list that
comprises two data frame(s):
a data frame containing the tree counts per class. This data frame must contain a a minimum set of columns (Nr, size_class, N, species.
a data frame that contains information about the class definition,
Value
If the user input allows to construct a well-defined
fe_tally_list object, this object will be returned. If not, the
function will terminate with an error.
