getVipVn {ropls} | R Documentation

## getVipVn method for (O)PLS(-DA) models

### Description

(Orthogonal) VIP of the (O)PLS(-DA) model

### Usage

    getVipVn(object, ...)

    ## S4 method for signature 'opls'
    getVipVn(object, orthoL = FALSE)

### Arguments

`object` | An S4 object of class `opls`, created by `opls` function.
`...` | Currently not used.
`orthoL` | Logical: Should the orthogonal VIP be returned (default is FALSE and the predictive VIP is returned)

### Value

Numeric vector with a length equal to the number of variables and a number of columns equal to the number of components

### Author(s)

Etienne Thevenot, etienne.thevenot@cea.fr

### References

Galindo-Prieto B., Eriksson L. and Trygg J. (2014). Variable influence on projection (VIP) for orthogonal projections to latent structures (OPLS). Journal of Chemometrics 28, 623-632.

### Examples

    data(sacurine)
    attach(sacurine)

    sacurine.plsda <- opls(dataMatrix,
                           sampleMetadata[, "gender"])

    getVipVn(sacurine.plsda)

    detach(sacurine)

[Package ropls version 1.14.1 Index]