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

Add documentation to sourmash signature describe for source file origin #769

Open
taylorreiter opened this issue Oct 31, 2019 · 1 comment

Comments

@taylorreiter
Copy link
Contributor

I calculated signatures like this:

sourmash compute -o {output} --merge {wildcards.sample}_mgx --scaled 2000 -k 21,31,51 --track-abundance {input.r1} {input.r2} 

and used sourmash signature describe to describe one signature and saw this output:

== This is sourmash version 2.2.0. ==
== Please cite Brown and Irber (2016), doi:10.21105/joss.00027. ==

loaded 1 signatures total.
---
signature filename: MSM6J2M3_mgx.un
signature: MSM6J2M3_mgx
source file: inputs/mgx/MSM6J2M3_R2.fastq.gz
md5: 310e18dc950a60a84b280f7a18959af7
k=51 molecule=DNA num=0 scaled=2000 seed=42 track_abundance=1
size: 21618
signature license: CC0

The source file line made me nervous because it made me think that only one file was used to calculate the signature, but then I realized that the source file that is recorded is probably the last file that is given to compute. This is fine, but I think we should add it to the documentation.

@ctb ctb changed the title Add documentation to sourmash signature describe for source file origin Add documentation to sourmash signature describe for source file origin Apr 23, 2021
@dkoslicki
Copy link
Collaborator

To chime in on this issue, I spent a while being misled by this too: I thought I was using the --merge flag incorrectly. Would be nice to know/be warned that the source_file will get funky when using --merged sketches

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

No branches or pull requests

2 participants