pr_addindex: add a spectral index to the list of available ones

View source: R/pr_addindex.R

pr_addindexR Documentation

add a spectral index to the list of available ones

Description

Function used to add a spectral index to the list of available ones

Usage

pr_addindex(Name, Formula, Description = NA, Sensitivity = NA, Reference = NA)

Arguments

Name

'character' Name of the new index (e.g., "myindex")

Formula

'character' Formula of the index. In the formula, bands are to be referred to the prefix "R", followed by the required wavelength /e.g., "R600 / R720"

Description

'character', Optional description of the index (e.g., "My Index for Nitrogen"), Default: NULL

Sensitivity

'character', Optional specification of index sensitivity (e.g., "Nitrogen concentration"), Default: NULL

Reference

'character', Optional specification of index literature reference (e.g., "me et al., (2020)), Default: NULL

Details

DETAILS

Value

NULL - The function is called for its side effects

Examples

## Not run: 
if(interactive()){
pr_addindex(Name = "myindex", Formula = "R600 / R700",
           Description = "My custom Index",
           Reference = "Me (2020)")
 }

## End(Not run)

ranghetti/prismaread documentation built on March 20, 2022, 11:37 a.m.