valid_gears_arg: Helper function to assure validity of gears argument
In mizer: Dynamic Multi-Species Size Spectrum Modelling
valid_gears_arg R Documentation
Helper function to assure validity of gears argument
Description
If the gears argument contains invalid gears, then these are
ignored but a warning is issued.
Usage
valid_gears_arg(object, gears = NULL, error_on_empty = FALSE)
Arguments
object
A MizerSim or MizerParams object from which the gears
should be selected.
gears
The gears to be selected. Optional. By default all gears
are selected. A vector of gear names.
error_on_empty
Whether to throw an error if there are zero valid
gears. Default FALSE.
Value
A vector of gear names.
mizer documentation built on Oct. 17, 2024, 9:07 a.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.
| valid_gears_arg | R Documentation |
Helper function to assure validity of gears argument
Description
If the gears argument contains invalid gears, then these are ignored but a warning is issued.
Usage
valid_gears_arg(object, gears = NULL, error_on_empty = FALSE)
Arguments
object |
A MizerSim or MizerParams object from which the gears should be selected. |
gears |
The gears to be selected. Optional. By default all gears are selected. A vector of gear names. |
error_on_empty |
Whether to throw an error if there are zero valid gears. Default FALSE. |
Value
A vector of gear names.
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.