caret_safs: Methods for Function 'safs'

caret::safsR Documentation

Methods for Function safs

Description

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

Usage

## S4 method for signature 'Speclib'
safs(x, y, cutoff = 0.95, returnData = TRUE, na.rm = FALSE, ...)

## S4 method for signature 'Nri'
safs(x, y, cutoff = 0.95, returnData = TRUE, na.rm = FALSE, ...)

## S4 method for signature 'Specfeat'
safs(x, y, cutoff = 0.95, returnData = TRUE, na.rm = FALSE, ...)

get_safs(x)

Arguments

x

Object of class Speclib, Nri or Specfeat. For get_safs, x must be the output of safs 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.

cutoff

The cutoff value of the correlation coefficients between response variables.

returnData

Logical. If TRUE, the updated object of x is returned, otherwise only the result of safs is returned.

na.rm

Logical. If TRUE, all variables are excluded which contain at least one non-finite value.

...

Further aruments passed to safs.

Value

If returnData == TRUE, an object of class Speclib or Nri, otherwise an object of class safs. 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

See Also

safs

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")

## Supervised feature selection using simulated annealing
## Note that this may take some time!
safs_res <- safs(spectral_data)

get_safs(safs_res)

plot(get_safs(safs_res))

## End(Not run)

hsdar documentation built on March 18, 2022, 6:35 p.m.