Difference between revisions of "Khmer"

From UFRC
Jump to navigation Jump to search
m (Text replacement - "#uppercase" to "uc")
 
(3 intermediate revisions by 2 users not shown)
Line 19: Line 19:
  
 
Khmer - python scripts for k-mer counting, filtering and graph traversal.
 
Khmer - python scripts for k-mer counting, filtering and graph traversal.
 
There's a khmer mailing list at librelist.com that you can use to get help with khmer. To sign up, email 'khmer@librelist.com'  to subscribe; then send your question/comment there.
 
 
'''IMPORTANT NOTE:'''
 
 
khmer is *pre-publication* and *research* software, so please keep in mind that (a) the code may have undiscovered bugs in it, (b) you should cite us, and (c) you should get in touch if you need to cite us, as we are writing up the project.
 
  
 
Available scripts: abundance-dist.py, count-median.py, do-partition.sh, filter-abund.py, find-knots.py, load-into-counting.py, merge-partitions.py, normalize-by-median.py, partition-graph.py, annotate-partitions.py, count-overlap.py, extract-partitions.py, filter-stoptags.py, load-graph.py, make-initial-stoptags.py, normalize-by-kadian.py, normalize-by-min.py
 
Available scripts: abundance-dist.py, count-median.py, do-partition.sh, filter-abund.py, find-knots.py, load-into-counting.py, merge-partitions.py, normalize-by-median.py, partition-graph.py, annotate-partitions.py, count-overlap.py, extract-partitions.py, filter-stoptags.py, load-graph.py, make-initial-stoptags.py, normalize-by-kadian.py, normalize-by-min.py
Line 35: Line 29:
 
*{{#var:app}}
 
*{{#var:app}}
 
==System Variables==
 
==System Variables==
* HPC_{{#uppercase:{{#var:app}}}}_DIR
+
* HPC_{{uc:{{#var:app}}}}_DIR
 
* HPC_KHMER_BIN
 
* HPC_KHMER_BIN
 
* HPC_KHMER_LIB
 
* HPC_KHMER_LIB
Line 55: Line 49:
 
: Crusoe et al., The khmer software package: enabling efficient sequence analysis. 2014. doi: 10.6084/m9.figshare.979190
 
: Crusoe et al., The khmer software package: enabling efficient sequence analysis. 2014. doi: 10.6084/m9.figshare.979190
  
If you use any of our published scientific methods, you should *also* cite the relevant paper(s), as directed below.
+
If you use any of khmer's published scientific methods, you should *also* cite the relevant paper(s), as directed below.
  
 
* Graph partitioning and/or compressible graph representation
 
* Graph partitioning and/or compressible graph representation
 
: The load-graph.py, partition-graph.py, find-knots.py, load-graph.py, and partition-graph.py scripts are part of the compressible graph representation and partitioning algorithms described in:
 
: The load-graph.py, partition-graph.py, find-knots.py, load-graph.py, and partition-graph.py scripts are part of the compressible graph representation and partitioning algorithms described in:
:: Pell J, Hintze A, Canino-Koning R, Howe A, Tiedje JM, Brown CT. Proc Natl Acad Sci U S A. 2012 Aug 14;109(33):13272-7. doi: 10.1073/pnas.1121464109. PMID: 22847406
+
:: Pell J, Hintze A, Canino-Koning R, Howe A, Tiedje JM, Brown CT
 +
:: Proc Natl Acad Sci U S A. 2012 Aug 14;109(33):13272-7
 +
:: doi: 10.1073/pnas.1121464109
 +
:: PMID: 22847406
 
* Digital normalization
 
* Digital normalization
 
: The normalize-by-median.py and count-median.py scripts are part of the digital normalization algorithm, described in:
 
: The normalize-by-median.py and count-median.py scripts are part of the digital normalization algorithm, described in:
Line 74: Line 71:
  
 
|}}
 
|}}
 +
=Validation=
 +
* Validated 4/5/2018

Latest revision as of 21:21, 6 December 2019

Description

khmer website  

Khmer - python scripts for k-mer counting, filtering and graph traversal.

Available scripts: abundance-dist.py, count-median.py, do-partition.sh, filter-abund.py, find-knots.py, load-into-counting.py, merge-partitions.py, normalize-by-median.py, partition-graph.py, annotate-partitions.py, count-overlap.py, extract-partitions.py, filter-stoptags.py, load-graph.py, make-initial-stoptags.py, normalize-by-kadian.py, normalize-by-min.py

Use "import khmer" in your script or in an interactive python session.

Required Modules

modules documentation

Serial

  • khmer

System Variables

  • HPC_KHMER_DIR
  • HPC_KHMER_BIN
  • HPC_KHMER_LIB




Citation

If you use the khmer software, you must cite:

Crusoe et al., The khmer software package: enabling efficient sequence analysis. 2014. doi: 10.6084/m9.figshare.979190

If you use any of khmer's published scientific methods, you should *also* cite the relevant paper(s), as directed below.

  • Graph partitioning and/or compressible graph representation
The load-graph.py, partition-graph.py, find-knots.py, load-graph.py, and partition-graph.py scripts are part of the compressible graph representation and partitioning algorithms described in:
Pell J, Hintze A, Canino-Koning R, Howe A, Tiedje JM, Brown CT
Proc Natl Acad Sci U S A. 2012 Aug 14;109(33):13272-7
doi: 10.1073/pnas.1121464109
PMID: 22847406
  • Digital normalization
The normalize-by-median.py and count-median.py scripts are part of the digital normalization algorithm, described in:
A Reference-Free Algorithm for Computational Normalization of Shotgun Sequencing Data
Brown CT, Howe AC, Zhang Q, Pyrkosz AB, Brom TH
arXiv:1203.4802 [q-bio.GN]
http://arxiv.org/abs/1203.4802
  • K-mer counting
The abundance-dist.py, filter-abund.py, and load-into-counting.py scripts implement the probabilistic k-mer counting described in:
These are not the k-mers you are looking for: efficient online k-mer counting using a probabilistic data structure
Zhang Q, Pell J, Canino-Koning R, Howe AC, Brown CT.
arXiv:1309.2975 [q-bio.GN]
http://arxiv.org/abs/1309.2975

Validation

  • Validated 4/5/2018