diat_spear: Calculates the SPEAR(herbicides) Index (SPEAR)

View source: R/diat_spear.R

diat_spearR Documentation

Calculates the SPEAR(herbicides) Index (SPEAR)

Description

The input for all of these functions is the resulting dataframe (resultLoad) obtained from the diat_loadData() function A CSV or dataframe cannot be used directly with these functions, they have to be loaded first with the diat_loadData() function so the acronyms and species' names are recognized References for the index:

  • Wood, R. J., Mitrovic, S. M., Lim, R. P., Warne, M. S. J., Dunlop, J., & Kefford, B. J. (2019). Benthic diatoms as indicators of herbicide toxicity in rivers–A new SPEcies At Risk (SPEARherbicides) index. Ecological Indicators, 99, 203-213.

Sample data in the examples is taken from:

  • Nicolosi Gelis, María Mercedes; Cochero, Joaquín; Donadelli, Jorge; Gómez, Nora. 2020. "Exploring the use of nuclear alterations, motility and ecological guilds in epipelic diatoms as biomonitoring tools for water quality improvement in urban impacted lowland streams". Ecological Indicators, 110, 105951. https://doi:10.1016/j.ecolind.2019.105951

Usage

diat_spear(resultLoad, maxDistTaxa = 2)

Arguments

resultLoad

The resulting list obtained from the diat_loadData() function

maxDistTaxa

Integer. Number of characters that can differ in the species' names when compared to the internal database's name in the heuristic search. Default = 2

Examples


# Example using sample data included in the package (sampleData):
data("diat_sampleData")
# First, the diat_loadData() function has to be called to read the data
# The data will be stored into a list (loadedData)
# And an output folder will be selected through a dialog box if resultsPath is empty
# In the example, a temporary directory will be used in resultsPath
df <- diat_loadData(diat_sampleData, resultsPath = tempdir())
spearResults <- diat_spear(df)


diathor documentation built on March 18, 2022, 7:25 p.m.