Skip to content

Commit

Permalink
issue 572, jaccard call added to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joey711 committed Mar 15, 2016
1 parent fbd10b2 commit da341fe
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
7 changes: 6 additions & 1 deletion R/distance-methods.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
#' of the supported options here,
#' and links to accompanying documentation.
#'
#' Note that for the common definition of \code{Jaccard} distance
#' using the \code{vegan-package} implementation,
#' an additional argument is needed, with the full call having the form:
#' \code{distance(physeq, method = "jaccard", binary = TRUE)}
#'
#' The following methods are implemented explicitly within
#' the \code{\link{phyloseq-package}},
#' and accessed by the following \code{method} options:
Expand Down Expand Up @@ -78,7 +83,7 @@
#' data(esophagus)
#' distance(esophagus, "uunifrac") # Unweighted UniFrac
#' distance(esophagus, "wunifrac") # weighted UniFrac
#' distance(esophagus, "jaccard") # vegdist jaccard
#' distance(esophagus, "jaccard", binary = T) # vegdist jaccard
#' distance(esophagus, "gower") # vegdist option "gower"
#' distance(esophagus, "g") # designdist method option "g"
#' distance(esophagus, "minkowski") # invokes a method from the base dist() function.
Expand Down
7 changes: 6 additions & 1 deletion man/distance.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit da341fe

Please sign in to comment.