intubate (version 1.0.0)

pls: Interfaces for pls package for data science pipelines.

Description

Interfaces to pls functions that can be used in a pipeline implemented by magrittr.

Usage

ntbt_cppls(data, ...)
ntbt_mvr(data, ...)
ntbt_pcr(data, ...)
ntbt_plsr(data, ...)

Arguments

data

data frame, tibble, list, ...

...

Other arguments passed to the corresponding interfaced function.

Value

Object returned by interfaced function.

Details

Interfaces call their corresponding interfaced function.

Examples

## Not run: 
# library(intubate)
# library(magrittr)
# library(pls)
# 
# ## cppls
# ## Original function to interface
# yarn.cppls <- cppls(density ~ NIR, ncomp = 6, data = yarn, validation = "CV")
# summary(yarn.cppls)
# 
# ## The interface reverses the order of data and formula
# yarn.cppls <- ntbt_cppls(yarn, density ~ NIR, ncomp = 6, validation = "CV")
# summary(yarn.cppls)
# 
# ## so it can be used easily in a pipeline.
# yarn %>%
#   ntbt_cppls(density ~ NIR, ncomp = 6, validation = "CV") %>%
#   summary()
# 
# ## mvr
# ## Original function to interface
# yarn.mvr <- mvr(density ~ NIR, ncomp = 6, data = yarn, validation = "CV",
#                 method = "oscorespls")
# summary(yarn.mvr)
# 
# ## The interface reverses the order of data and formula
# yarn.mvr <- ntbt_mvr(yarn, density ~ NIR, ncomp = 6, validation = "CV",
#                      method = "oscorespls")
# summary(yarn.mvr)
# 
# ## so it can be used easily in a pipeline.
# yarn %>%
#   ntbt_mvr(density ~ NIR, ncomp = 6, validation = "CV",
#            method = "oscorespls") %>%
#   summary()
# 
# ## pcr
# ## Original function to interface
# yarn.pcr <- pcr(density ~ NIR, ncomp = 6, data = yarn, validation = "CV")
# summary(yarn.pcr)
# 
# ## The interface reverses the order of data and formula
# yarn.pcr <- ntbt_pcr(yarn, density ~ NIR, ncomp = 6, validation = "CV")
# summary(yarn.pcr)
# 
# ## so it can be used easily in a pipeline.
# yarn %>%
#   ntbt_pcr(density ~ NIR, ncomp = 6, validation = "CV") %>%
#   summary()
# 
# ## plsr
# ## Original function to interface
# yarn.plsr <- plsr(density ~ NIR, ncomp = 6, data = yarn, validation = "CV")
# summary(yarn.plsr)
# 
# ## The interface reverses the order of data and formula
# yarn.plsr <- ntbt_plsr(yarn, density ~ NIR, ncomp = 6, validation = "CV")
# summary(yarn.plsr)
# 
# ## so it can be used easily in a pipeline.
# yarn %>%
#   ntbt_plsr(density ~ NIR, ncomp = 6, validation = "CV") %>%
#   summary()
# ## End(Not run)