fhCheck: Basic Checks of input Fire History

View source: R/fhCheck.R

fhCheckR Documentation

Basic Checks of input Fire History

Description

Perfoms checks on input dataset to check it is correctly formatted for use in FAME analysis

Usage

fhCheck(inFH = inFH, inFHLayer = inFHLayer, validFIRETYPE = validFIRETYPE)

Arguments

inFH

and input fire history polygon/mutipolygon data set with columns SEASON and FIRETYPE provided as shapefile, geopackage or ESRI geodatabase file, or the name of an sf object. if the geometries contain other than polygon/mutipolygon an error will result.

inFHLayer

Layer name if inFH has more than one layer ( for instance in a .gpkg) this allows selection of a particular layer, otherwise first layer is used (Default = NULL) #' @param validFIRETYPE vector of valid firetype names in the input FIRETYPE column

Value

correctly formatted Fire History Polygon dataset as sf for use in fhProcess1()


nevilamos/FAMEFMR documentation built on April 17, 2025, 9:32 p.m.