sourmash
Plugin Overview¶
This QIIME 2 plugin wraps sourmash and supports the calculation and comparison of MinHash signatures.
- version:
0.0.0 - website: http://
sourmash .readthedocs .io /en /latest/ - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org - citations:
- Brown & Irber, 2016; Crusoe et al., 2015
Actions¶
| Name | Type | Short Description |
|---|---|---|
| compute | method | Compute sourmash signature |
| compare | method | Compare sourmash signatures |
Artifact Classes¶
MinHashSig |
Formats¶
MinHashSigJson |
MinHashSigJsonDirFormat |
sourmash compute¶
Computes a sourmash MinHash signature from fasta/q files.
Citations¶
Brown & Irber, 2016; Crusoe et al., 2015
Inputs¶
- sequence_file:
SampleData[SequencesWithQuality | MAGs] <no description>[required]
Parameters¶
- ksizes:
Int <no description>[required]
- scaled:
Int <no description>[required]
- track_abundance:
Bool <no description>[default:
True]
Outputs¶
- min_hash_signature:
MinHashSig <no description>[required]
sourmash compare¶
Compares sourmash signatures and calculates Jacaard distance matrix.
Citations¶
Brown & Irber, 2016; Crusoe et al., 2015
Inputs¶
- min_hash_signature:
MinHashSig <no description>[required]
Parameters¶
Outputs¶
- compare_output:
DistanceMatrix <no description>[required]
- Brown, C. T., & Irber, L. (2016). sourmash: a library for MinHash sketching of DNA. Journal of Open Source Software, 1(5), 27. 10.21105/joss.00027
- Crusoe, M. R., Alameldin, H. F., Awad, S., Bucher, E., Caldwell, A., Cartwright, R., Charbonneau, A., Constantinides, B., Edvenson, G., Fay, S., Fenton, J., Fenzl, T., Fish, J., Garcia-Gutierrez, L., Garland, P., Gluck, J., González, I., Guermond, S., Guo, J., … Brown, C. T. (2015). The khmer software package: enabling efficient nucleotide sequence analysis. 10.12688/f1000research.6924.1