From db7b2ae89d2750d34afc9f9acf871f8c8e67c925 Mon Sep 17 00:00:00 2001 From: Ted Hart Date: Thu, 5 Mar 2015 23:15:07 -0800 Subject: [PATCH] updated niche overlap docs --- R/niche_overlap_null.R | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/R/niche_overlap_null.R b/R/niche_overlap_null.R index 4bc92ce..01f0c7e 100644 --- a/R/niche_overlap_null.R +++ b/R/niche_overlap_null.R @@ -1,6 +1,6 @@ -#'Niche overlap -#'@description Create a niche overlap null model -#'@param speciesData a dataframe +#'Niche overlap null models +#'@description Create a niche overlap null models, choices of algorithm and metric are constrained to be valid for niche null models. +#'@param speciesData a data frame in which each row is a species, each column is a resource utilization category, and the entries represent the quantity of the resource used by each species. Examples might be the amount of time a species spends foraging in different microhabitats, the biomass of different prey types, or counts of the number of times an adult female oviposits eggs on different species of a host plant. #'@param algo the algorithm to use, must be "ra1", "ra2", "ra3", "ra4" #'@param metric the metric used to caluclate the null model: choices are "pianka", "czekanowski", "pianka_var", "czekanowski_var", "pianka_skew", "czekanowski_skew"; default is pianka #'@param nReps the number of replicates to run the null model.