savedata_options: Data saving options.

In FIESTAutils: Utility Functions for Forest Inventory Estimation and Analysis

Data saving options.

Description

Returns a list of user-supplied parameters and parameter values for saving data.

Usage

savedata_options(
  outfolder = NULL,
  out_fmt = "csv",
  outsp_fmt = "shp",
  outobj_fmt = "rds",
  out_dsn = NULL,
  out_layer = "outdat",
  outfn.pre = NULL,
  outfn.date = FALSE,
  addtitle = TRUE,
  raw_fmt = "csv",
  raw_dsn = NULL,
  overwrite_dsn = FALSE,
  overwrite_layer = TRUE,
  append_layer = FALSE,
  add_layer = TRUE,
  layer.pre = NULL,
  outconn = NULL,
  ...
)

Arguments

outfolder	String. The outfolder to write files to. If NULL, files are written to working directory, or if gui=TRUE, a window to browse.
out_fmt	String. Format for output tables ('csv', 'sqlite', 'gpkg', 'gdb').
outsp_fmt	String. Format for output spatial ('shp', sqlite', 'gpkg', 'gdb').
outobj_fmt	String. Format for output spatial ('rda', 'rds', 'llo').
out_dsn	String. Data source name for output. If extension is not included, out_fmt is used. Use full path if outfolder=NULL.
out_layer	outlayer.
outfn.pre	String. If savedata=TRUE, prefix for output files. If rawdata=TRUE, prefix for rawdata files (if raw_fmt = 'csv') or raw_dsn (if raw_fmt != 'csv').
outfn.date	Logical. If TRUE, add current date to out_dsn.
addtitle	Logical. If TRUE and savedata=TRUE, adds title to outfile.
raw_fmt	String. Format for output rawdata tables ('sqlite', 'gpkg', 'csv', 'gdb').
raw_dsn	String. Data source name for rawdata output. If extension is not included, out_fmt is used. Use full path if outfolder=NULL.
overwrite_dsn	Logical. If TRUE, overwrites raw_dsn, if exists.
overwrite_layer	Logical. If TRUE, overwrites the output. If rawdata=TRUE, overwrites out_layer in rawdata folder (if raw_fmt = 'csv') or out_layers in raw_dsn (if raw_fmt != 'csv').
append_layer	Logical. If TRUE, and appends data to existing *.csv files (if *_fmt = 'csv') or *_dsn layers (if *_fmt != 'csv".
add_layer	Logical. If TRUE, adds layer to an existing out_dsn (if out_fmt != c('csv','shp')).
layer.pre	Layer prefix.
outconn	Open database connection to save to.
...	For extendibility.

Details

If no parameters, an empty list is returned.

Value

A list of user-supplied parameters and parameter values for saving data.

Author(s)

Grayson W. White

Examples

savedata_options(outfolder = "path", overwrite_dsn = FALSE)

FIESTAutils documentation built on May 29, 2024, 4:06 a.m.