CheckentropartArguments: Checks the arguments of a function of the package entropart
In entropart: Entropy Partitioning to Measure Diversity
View source: R/CheckentropartArguments.R
CheckentropartArguments R Documentation
Checks the arguments of a function of the package entropart
Description
This function is used internally to verify that arguments passed to entropart functions such as PhyloDiversity are correct.
Usage
CheckentropartArguments()
Details
The function compares the arguments passed to its parent function to the type they should be and performs some extra tests (e.g. probabilities must be positive and sum to 1). It stops if an argument is not correct.
Value
Returns TRUE or stops if a problem is detected.
entropart documentation built on Sept. 11, 2024, 6:20 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.
View source: R/CheckentropartArguments.R
| CheckentropartArguments | R Documentation |
Checks the arguments of a function of the package entropart
Description
This function is used internally to verify that arguments passed to entropart functions such as PhyloDiversity are correct.
Usage
CheckentropartArguments()
Details
The function compares the arguments passed to its parent function to the type they should be and performs some extra tests (e.g. probabilities must be positive and sum to 1). It stops if an argument is not correct.
Value
Returns TRUE or stops if a problem is detected.
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.