multest_options: Multest output options.

In FIESTAutils: Utility Functions for Forest Inventory Estimation and Analysis

Multest output options.

Description

Returns a list of user-supplied parameters and parameter values for outputting multest with custom aesthetics.

Usage

multest_options(
  multest_estimators = "all",
  multest_fmt = "csv",
  multest_outfolder = NULL,
  multest_dsn = NULL,
  multest_layer = NULL,
  multest.append = FALSE,
  multest.AOIonly = FALSE,
  ...
)

Arguments

multest_estimators	String vector. If multest = TRUE, vector of estimators to include in multest output ('JU.GREG','JU.EBLUP','JFH','hbsaeU','hbsaeA'). See ref_estimators for descriptions. Use multest_estimators = 'all' to output all estimators.
multest_fmt	String. Format for multest output tables ('csv', 'sqlite', 'gpkg').
multest_outfolder	String. Outfolder for multest. If NULL, same as outfolder.
multest_dsn	String. Name of database if multest_fmt = c('sqlite', 'gpkg').
multest_layer	String. Name of database layer if multest_fmt = c('sqlite', 'gpkg').
multest.append	Logical. If TRUE, appends multest dataframe to output.
multest.AOIonly	Logical. If TRUE, appends multest dataframe (AOI=1) to output.
...	For extendibility.

Details

If no parameters, an empty list is returned.

Value

A list of user-supplied parameters and parameter values for outputting multest.

Author(s)

Grayson W. White

Examples

multest_options(multest.append = TRUE)

FIESTAutils documentation built on April 4, 2025, 2:04 a.m.