hsdar: Boruta – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Boruta

Methods for Function Boruta

Description

Methods for function Boruta in package Boruta. Please refer to help pages in the Boruta-package for further information.

Usage

## S4 method for signature 'Speclib'
Boruta(x, y, ..., returnData = TRUE, includeTentative = FALSE,
                           na.rm = FALSE)

## S4 method for signature 'Nri'
Boruta(x, y, ..., returnData = TRUE, includeTentative = FALSE,
                       na.rm = FALSE)

## S4 method for signature 'Specfeat'
Boruta(x, y, ..., returnData = TRUE, includeTentative = FALSE,
                            na.rm = FALSE)

get_Boruta(x)

Arguments

`x`	Object of class `Speclib`, `Nri` or `Specfeat`. For `get_Boruta`, `x` must be the output of `Boruta` as `Speclib` or `Nri`.
`y`	A numeric or factor vector containing the outcome for each sample. If missing, the response variable set by `setResponse` is used.
`returnData`	Logical. If TRUE, the updated object of `x` is returned, otherwise only the result of `Boruta` is returned.
`includeTentative`	Logical. If TRUE, the tentative variables are kept and returned in the `Speclib`-object.
`na.rm`	Logical. If TRUE, all variables are excluded which contain at least one non-finite value.
`...`	Further arguments passed to `Boruta`.

Value

If returnData == TRUE, an object of class Speclib or Nri, otherwise an object of class Boruta. Note that if x is an object of class Specfeat, the function returns an object of class Speclib containing the relevant transformed band values.

Author(s)

Lukas Lehnert

Examples

## Not run: 
data(spectral_data)

## Set response variable (Chlorophyll content)
spectral_data <- setResponse(spectral_data, "chlorophyll")

## Set additional predictor variables from the SI
spectral_data <- setPredictor(spectral_data, "season")

## Run Boruta
## Note that this may take some time!
bor_res <- Boruta(spectral_data)

get_Boruta(bor_res)
plot(get_Boruta(bor_res))

## End(Not run)

hsdar

Manage, Analyse and Simulate Hyperspectral Data

v1.0.3

GPL

Authors

Lukas W. Lehnert [cre, aut] (<https://orcid.org/0000-0002-5229-2282>), Hanna Meyer [ctb], Joerg Bendix [ctb]

Initial release

2020-08-04