Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abundance classification #664

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from
Open

Abundance classification #664

wants to merge 2 commits into from

Conversation

TuomasBorman
Copy link
Contributor

This PR implements abundance classification that is introduced in this paper:

Sizhong Yang, Matthias Winkel, Dirk Wagner, Susanne Liebner, Community structure of rare methanogenic archaea: insight from a single functional group, FEMS Microbiology Ecology, Volume 93, Issue 11, November 2017, fix126, https://doi.org/10.1093/femsec/fix126

New functions include:

  • getAbundant(): taxa above abundance threshold
  • getLowAbundant(): taxa below abundance threshold (and between conditionally & permanently rare thresholds)
  • getPermanentlyRare(): taxa below abundance threshold and below permanently rare threshold
  • getConditionallyRaret(): taxa below abundance threshold and above conditionally rare threshold

TODO:

  • Update documentation
  • Clean code and check that everything works
  • Add unit tests
  • Consider names getPermanentlyLowAbundant() and getConditionallyLowAbundant(). They are longer but more distinct from getRare() which is based on prevalence.

@antagomir
Copy link
Member

Is getLowAbundant needed if it is just a complement of getAbundant?

@TuomasBorman
Copy link
Contributor Author

  • Abundant taxa: Taxa with an average abundance exceeding abundant.th.

  • Low abundant / rare taxa: Taxa with an average abundance not exceeding abundant.th. Optionally, if specified, they must also satisfy the condition:
    condition.th >= (abundance_max / abundance_min) > permanent.th.

  • Conditionally rare taxa (CRT): Taxa with an average abundance not exceeding abundant.th and with a maximum-to-minimum abundance ratio (abundance_max / abundance_min) greater than condition.th.

  • Permanently rare taxa (PRT): Taxa with an average abundance not exceeding abundant.th and with a maximum-to-minimum abundance ratio (abundance_max / abundance_min) less than or equal to permanent.th.

In the simplest case it is complement, but in the article they further classified the rare taxa

@antagomir
Copy link
Member

Is the Shade et al. manuscript also taken into account?

@TuomasBorman
Copy link
Contributor Author

See: microbiome/miaTime#103

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants