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 a 'name' config to sourmash sketch param strings? #1315

Open
ctb opened this issue Feb 9, 2021 · 4 comments
Open

add a 'name' config to sourmash sketch param strings? #1315

ctb opened this issue Feb 9, 2021 · 4 comments
Labels
4.0 issues to address for a 4.0 release

Comments

@ctb
Copy link
Contributor

ctb commented Feb 9, 2021

we could allow sourmash sketch to take name= in param strings, e.g.

sourmash sketch dna -p k=31,name='cool name, luke'

rationale: when writing up the docs for sourmash sketch per #1283 (review), I realized that I had done signature naming the way I had because of limitations imposed by sourmash compute: to whit, that we could only specify one name on the command line for all the signatures being created.

However, with sourmash sketch, we create different signatures for each param string.

In a major scope expansion of this issue, we could also allow template variables like {header} and {len} to be used, to be interpreted by Python for each sequence...

@ctb
Copy link
Contributor Author

ctb commented Feb 9, 2021

it would also be nice to support explicit naming from filename, and/or basename, and/or maybe even accession from a CSV of some sort.

@bluegenes
Copy link
Contributor

bluegenes commented Feb 17, 2021

I REALLY like adding a name option in the param string!

template vars seem very handy, but maybe also dangerous?

name from csv is what I end up doing via snakemake, so doing it natively would be neat :)

@ctb
Copy link
Contributor Author

ctb commented Feb 17, 2021

also, see @taylorreiter comment in https://github.com/dib-lab/sourmash/pull/1283/files#r572495952 -

docs say:

You can also stream any of these formats into sourmash sketch via stdin by using - as the input filename.

@taylorreiter -

Yes, that's true, but then the name of the sig is recorded as - which is really confusing when you compare a bunch of files.

Also, should there be an example for how to do this?

@ctb ctb added the 4.0 issues to address for a 4.0 release label Feb 17, 2021
@ctb
Copy link
Contributor Author

ctb commented Mar 2, 2021

also, see @taylorreiter comment in https://github.com/dib-lab/sourmash/pull/1283/files#r572495952 -

docs say:

You can also stream any of these formats into sourmash sketch via stdin by using - as the input filename.

@taylorreiter -

Yes, that's true, but then the name of the sig is recorded as - which is really confusing when you compare a bunch of files.

fixed in #1347 - name/filename is now empty.

Also, should there be an example for how to do this?

added in 2ac0b96!

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

No branches or pull requests

2 participants