Skip to content

Commit

Permalink
Fix typos and update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mahendra-mariadassou committed May 30, 2019
1 parent 72215e3 commit 74d8079
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Title: PhyloseqExtended
Version: 0.1.0.9000
Authors@R:
person(given = "Mahendra",
family = "Mahendra",
family = "Mariadassou",
role = c("aut", "cre"),
email = "[email protected]")
Description: Adds severals additional functions to phyloseq, mainly used for training.
Description: Adds severals additional functions to phyloseq (rarefaction curves, phylogenetic diversities, specificity and prevalence indices, nice composition plots, etc). Mostly used during training sessions.
License: GPL-3
Encoding: UTF-8
LazyData: true
Expand Down
2 changes: 2 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

export(estimate_local_specificity)
export(estimate_prevalence)
export(fast_tax_glom)
export(ggformat)
export(ggpdrare)
export(ggrare)
Expand All @@ -24,5 +25,6 @@ importFrom(biomformat,biom_data)
importFrom(biomformat,read_biom)
importFrom(biomformat,sample_metadata)
importFrom(plyr,rbind.fill.matrix)
importFrom(tibble,column_to_rownames)
importFrom(vegan,ordilabel)
importFrom(vegan,specnumber)
4 changes: 0 additions & 4 deletions R/richness.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
require(parallel)
options(mc.cores= 2)

#' Phylogenetic diversity
#'
#' @param physeq phyloseq class object, from which phylogeny and abundance data are extracted
Expand Down Expand Up @@ -46,7 +43,6 @@ phylodiv <- function(physeq, theta = 0) {
return(pd)
}


#' Rarefaction curves for phylogenetic diversity, ggplot-style
#'
#' @inheritParams ggrare
Expand Down
2 changes: 2 additions & 0 deletions R/specificity_methods.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Compute specificity of a vector
## x represents (possibly not normalised) distribution of quantity
## of interest across conditions
#' @keywords internal
specificity <- function(x, index = c("shannon", "simpson", "yanai", "indspec"), groupfrac = NULL) {
## Args:
## - x: matrix (vectors are automatically coerced to 1-row matrices), specificity
Expand Down Expand Up @@ -54,6 +55,7 @@ specificity <- function(x, index = c("shannon", "simpson", "yanai", "indspec"),
## Compute local specificity of a vector
## x represents (possibly not normalised) distribution of quantity
## of interest across conditions
#' @keywords internal
local_specificity <- function(x, index = c("fraction", "indspec"), groupfrac = NULL) {
## Args:
## - x: matrix (vectors are automatically coerced to 1-row matrices), specificity
Expand Down
2 changes: 1 addition & 1 deletion man/top_taxa.Rd

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

0 comments on commit 74d8079

Please sign in to comment.