removeBackgroundSpecies: Remove all background species
In mizer: Dynamic Multi-Species Size Spectrum Modelling
removeBackgroundSpecies R Documentation
Remove all background species
Description
Removes all species that have been marked as background species with
markBackground().
Usage
removeBackgroundSpecies(params)
Arguments
params
A MizerParams object
Details
This is just a shorthand for
removeSpecies(params, species_params(params)$is_background)
Value
A MizerParams object with background species removed
See Also
markBackground()
Examples
params <- markBackground(NS_params,
species = c("Sprat", "Sandeel", "N.pout"))
params <- removeBackgroundSpecies(params)
species_params(params)$species
mizer documentation built on Aug. 31, 2026, 5:08 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| removeBackgroundSpecies | R Documentation |
Remove all background species
Description
Removes all species that have been marked as background species with
markBackground().
Usage
removeBackgroundSpecies(params)
Arguments
params |
A MizerParams object |
Details
This is just a shorthand for
removeSpecies(params, species_params(params)$is_background)
Value
A MizerParams object with background species removed
See Also
markBackground()
Examples
params <- markBackground(NS_params,
species = c("Sprat", "Sandeel", "N.pout"))
params <- removeBackgroundSpecies(params)
species_params(params)$species
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.