RegroupLengthDistribution: Regroup length distribution to common intervals
In StoXProject/RstoxBase: Base StoX Functions
View source: R/LengthDistribution.R
RegroupLengthDistribution R Documentation
Regroup length distribution to common intervals
Description
The RegroupLengthDistribution function is used to set a common length group resolution for one or all SpeciesCategories throughout the output length distribution dataset. The function aggregates the WeightedNumber of the LengthDistributionData
Usage
RegroupLengthDistribution(LengthDistributionData, LengthInterval = numeric())
Arguments
LengthDistributionData
The LengthDistributionData data.
LengthInterval
Specifies the new length intervals, given as a single numeric value representing the constant length interval widths, (starting from 0).
Details
An intevral vector starting from 0 with increments of Resolution will be created, and the current length intervals (IndividualTotalLength, IndividualTotalLength + LengthResolution) will be located into the interval vector. Present intervals that intersect with more than one interval in the interval vector result in an error (e.g. IndividualTotalLength = 2.4 with LengthResolution = 0.3 will intersect with two intervals when Resolution = 0.5, and IndividualTotalLength = 2.4 with LengthResolution = 0.1 will intersect with two intervals when Resolution = 0.05).
Value
An object of StoX data type LengthDistributionData.
StoXProject/RstoxBase documentation built on Nov. 6, 2024, noon
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.
View source: R/LengthDistribution.R
| RegroupLengthDistribution | R Documentation |
Regroup length distribution to common intervals
Description
The RegroupLengthDistribution function is used to set a common length group resolution for one or all SpeciesCategories throughout the output length distribution dataset. The function aggregates the WeightedNumber of the LengthDistributionData
Usage
RegroupLengthDistribution(LengthDistributionData, LengthInterval = numeric())
Arguments
LengthDistributionData |
The |
LengthInterval |
Specifies the new length intervals, given as a single numeric value representing the constant length interval widths, (starting from 0). |
Details
An intevral vector starting from 0 with increments of Resolution will be created, and the current length intervals (IndividualTotalLength, IndividualTotalLength + LengthResolution) will be located into the interval vector. Present intervals that intersect with more than one interval in the interval vector result in an error (e.g. IndividualTotalLength = 2.4 with LengthResolution = 0.3 will intersect with two intervals when Resolution = 0.5, and IndividualTotalLength = 2.4 with LengthResolution = 0.1 will intersect with two intervals when Resolution = 0.05).
Value
An object of StoX data type LengthDistributionData.
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.