diff --git a/R/calc_shannon.R b/R/calc_shannon.R index 70e9eed..184502e 100644 --- a/R/calc_shannon.R +++ b/R/calc_shannon.R @@ -3,6 +3,7 @@ #' @param community Community. #' @param no_asv_per_species Number of genetic variants per species. #' @param augment_community Build up community by from species and number of occurences (TRUE), or use raw occurrences (FALSE) +#' @param only_sum_freq Only sum the frequencies together, instead of calculating Shannon information. #' @param Hill Return as first order Hill number. Boolean #' #' @return Shannon diversity. @@ -34,6 +35,7 @@ calc_shannon <- function(community, no_asv_per_species, augment_community = TRUE, + only_sum_freq = FALSE, Hill = TRUE) { if(augment_community){ community_aug <- rep(community, no_asv_per_species) diff --git a/man/calc_shannon.Rd b/man/calc_shannon.Rd index 7be2a16..c228852 100644 --- a/man/calc_shannon.Rd +++ b/man/calc_shannon.Rd @@ -8,6 +8,7 @@ calc_shannon( community, no_asv_per_species, augment_community = TRUE, + only_sum_freq = FALSE, Hill = TRUE ) } @@ -18,6 +19,8 @@ calc_shannon( \item{augment_community}{Build up community by from species and number of occurences (TRUE), or use raw occurrences (FALSE)} +\item{only_sum_freq}{Only sum the frequencies together, instead of calculating Shannon information.} + \item{Hill}{Return as first order Hill number. Boolean} } \value{