defaultArguments: Define the default arguments

In LTLA/bluster: Clustering Algorithms for Bioconductor

Define the default arguments

Description

Provide a consistent mechanism to handle specification of default arguments to the underlying clustering functions.

Usage

.defaultScalarArguments(x)

.showScalarArguments(object)

.extractScalarArguments(x)

Arguments

x, object

A BlusterParam object.

Details

The idea is to simplify the derivation of new BlusterParam objects, by allowing developers to indicate that the underlying function default should be used for particular arguments. This avoids duplication of the default arguments in the object constructor; instead, default arguments can be indicated as such by setting them to NULL, in which case they will not be explicitly passed to the underlying clustering function.

Value

For .defaultScalarArguments, a named character vector is returned. Each entry corresponds to an argument to the clustering function - the name is the argument name, and the value is the argument type.

For .extractScalarArguments, a named list of non-default scalar arguments is returned. Any arguments set to their default values are omitted from the list.

For .showScalarArguments, the values of the arguments are printed to screen. Default values are marked with [default].

Author(s)

Aaron Lun

Examples

.defaultScalarArguments(PamParam(10))
.extractScalarArguments(PamParam(10))
.extractScalarArguments(PamParam(10, variant="faster"))

LTLA/bluster documentation built on Sept. 8, 2024, 4:37 a.m.