Learn R Programming

mizer (version 3.2.0)

removeBackgroundSpecies: Remove all background species

Description

Removes all species that have been marked as background species with markBackground().

Usage

removeBackgroundSpecies(params)

Value

A MizerParams object with background species removed

Arguments

params

A MizerParams object

Details

This is just a shorthand for removeSpecies(params, species_params(params)$is_background)

See Also

markBackground()

Examples

Run this code
params <- markBackground(NS_params,
                         species = c("Sprat", "Sandeel", "N.pout"))
params <- removeBackgroundSpecies(params)
species_params(params)$species

Run the code above in your browser using DataLab