setParams: Set parameters

Description Usage Arguments Details Value Examples

View source: R/params-functions.R

Description

Set multiple parameters in a Params object.

Usage

1
setParams(params, update = NULL, ...)

Arguments

params

Params object to set parameters in.

update

list of parameters to set where names(update) are the names of the parameters to set and the items in the list are values.

...

additional parameters to set. These are combined with any parameters specified in update.

Details

Each parameter is set by a call to setParam. If the same parameter is specified multiple times it will be set multiple times. Parameters can be specified using a list via update (useful when collecting parameter values in some way) or individually (useful when setting them manually), see examples.

Value

Params object with updated values.

Examples

1
2
3
4
5
6
7
8
params <- newSimpleParams()
params
# Set individually
params <- setParams(params, nGenes = 1000, nCells = 50)
params
# Set via update list
params <- setParams(params, list(mean.rate = 0.2, mean.shape = 0.8))
params

splatter documentation built on Dec. 7, 2018, 6 p.m.