NEON-biodiversity/Ostats

Vignette & function documentation suggestions

Closed this issue · 2 comments

From the vignette:
The argument circular defaults to TRUE, meaning the data are on a linear scale (i.e., body masses of individual small mammals). The alternative is TRUE for data that are periodic (e.g., measured in radians or degrees).

Should be:
The argument circular defaults to FALSE, meaning the data are on a linear scale (i.e., body masses of individual small mammals). The alternative is TRUE for data that are periodic (e.g., measured in radians or degrees).

From the help file (e.g. running ?Ostats):

traits a numeric vector or matrix of trait measurements. The number of elements in the vector or number of rows in the matrix is the number of individuals, and the number of columns of the matrix is the number of traits

When I input traits as a vector (e.g. data$column or even as.vector(data$column)), it throws the error Error in rep(discrete, ncol(traits)) : invalid 'times' argument

If I input it as a single column matrix (e.g. as.matrix(data$column)) it works. So, I'd recommend either changing the function to accept a vector or change the help to say something like "a matrix of trait measurements (single column matrix if using one trait)..."

Thanks you're right in both cases!

I resolved both these in 4ab743d , first just changed the typo in the vignette, then actually instead of changing the help documentation I added a line in Ostats() and Ostats_multivariate() to coerce input to a one col matrix, if it's given as a vector.