buildEnsemble: Build Ensemble

Description Usage Arguments Details Value Methods (by class)

Description

buildEnsemble builds an ensemble from ExprsModel or ExprsPipeline objects. See Details.

Usage

1
2
3
4
5
6
7
8
buildEnsemble(object, ...)

## S4 method for signature 'ExprsModel'
buildEnsemble(object, ...)

## S4 method for signature 'ExprsPipeline'
buildEnsemble(object, colBy = 0, how = 0,
  gate = 0, top = 0)

Arguments

object

An ExprsPipeline-class object.

...

Additional ExprsModel objects to use in the ensemble. Argument applies to the ExprsModel-class method only.

colBy

A character vector or string. Specifies column(s) to use when filtering by model performance. Listing multiple columns will result in a filter based on the product all listed columns.

how

A numeric scalar. Arguments between 0 and 1 will impose a threshold or ceiling filter, respectively, based on the raw value of colBy. Arguments between 1 and 100 will impose a filter based on the percentile of colBy. The user may also provide "midrange", "median", or "mean" as an argument for these filters.

gate

A numeric scalar. Arguments between 0 and 1 will impose a threshold or ceiling filter, respectively, based on the raw value of colBy. Arguments between 1 and 100 will impose a filter based on the percentile of colBy. The user may also provide "midrange", "median", or "mean" as an argument for these filters.

top

A numeric scalar. Determines the top N models based on colBy to include after the threshold and ceiling filters. In the case that the @summary slot contains the column "boot", this selects the top N models for each unique bootstrap.

Details

This function can combine any number of model objects into an ensemble. These models do not necessarily have to derive from the same build method. In this way, it works like conjoin.

This function can also build an ensemble from pipeline objects. It does this by calling pipeFilter, then joining the remaining models into an ensemble. As an adjunct to this method, consider first combining multiple pipeline objects with conjoin.

Value

An ExprsEnsemble-class object.

Methods (by class)


tpq/exprso documentation built on July 27, 2019, 8:44 a.m.