projectMaxnet: Project maxnet model

In peterbat1/fitMaxnet: Fit MaxEnt Niche Models Using maxnet

Project maxnet model

Description

Project a maxnet model fitted using fitModel

Usage

projectMaxnet(
  taxonName = NULL,
  maxnetModel,
  type = "exponential",
  doClamp = FALSE,
  dataType = "FLT4S",
  baseOutputPath,
  fileLabel = NULL,
  makeTaxonFolder = FALSE,
  quiet = TRUE
)

Arguments

taxonName	String. Taxonomic name associated with this model; used to construct a file name for the output raster file.
maxnetModel	String. Full path name to the .Rd file storing a fitted maxnet model produced by the companion functions fit_maxnet and fitModels.
type	String. The type of scaling applied to predicted model values.
doClamp	Logical. Should values of predictors (covariates) be clamped to those seen during model fitting? Default is FASLE, no clamping.
dataType	String. Data format to be used. Default is "FLT4S". Only alternative at moment is "INT4S".
baseOutputPath	String. Full path to the output folder to receive the produced raster.
fileLabel	String. An identifying tag to be included in the output filename.
makeTaxonFolder	Logical. Should a sub-folder on baseOutputPath be created using taxonName?
quiet	Logical. Proceed without emitting progress messages?

Details

Function prepProjData MUST be run before calling this function to prepare global data objects needed for the projection.

NOTE: The resulting raster is written to the specified output folder with the file name composed by concatenating the taxon name spaces replaced by underscores), "projection" and, if supplied, the character object fileTag.

If a file with this name already exists in the output folder, it will be overwritten.

If dataType = "INT4S" is given, output is multiplied by 1,000 and truncated to an integer. Therefore, real values (to 4 dec. places) must be regenerated after loading the TIFF file by dividing the raster values by 1,000.

Value

Nothing

peterbat1/fitMaxnet documentation built on Sept. 17, 2024, 10:50 p.m.