Open kvn95ss opened 2 years ago
EDIT: saw this issue - #37 I think I was facing errors due to this behavior.
It might actually be nice to have something like --out-dir
and --out-prefix
, where by default, --out-dir
is current working directory (NOT the current behavior) and --out-prefix
is squirls
(part of the current behavior). So, to get the output in current working directory I just have to use -
java -jar squirls-cli.jar annotate-vcf -d resources example.vcf test_out
instead of
java -jar squirls-cli.jar annotate-vcf -d resources example.vcf /full/path/test_out
I also admit its nice to have only one CLI argument for output, but that implies the output directory and working directory are the same. Also, in the documentation the wording is as follows -
To annotate variants in the example.vcf file (an example VCF file with 6 variants stored in Squirls repository), run:
$ java -jar squirls-cli.jar annotate-vcf -d $SQUIRLS_DATA example.vcf path/to/output/file
- -d | --data-directory - path to Squirls data directory
- path to the VCF file with variants
- output prefix for the generated files
The last line talks only about the prefix for generated files, and doesn't indicate anything about the directories they should be in. The example provided makes sense only in retrospect.
Hi @kvn95ss , thanks for pointing out the issue. It looks like the succinctness of the current CLI comes at the expense of user-friendliness. I use absolute paths almost everywhere which led me to missing the bug you described above.
The short term fix for the issue is to use an absolute path as part of the prefix. However, for the long term I'll add --out-dir
option. If missing, the --out-dir
will fall back to the current working directory.
It is not possible to add default value for the output prefix because positional parameters are required. I do not want to remove CLI options at this time but I'll do that in the next major release.
Thanks a lot again & cheers!
Hello,
I tried to run the tool on the test vcf -
java -jar squirls-cli.jar annotate-vcf -d resources example.vcf test_out.vcf
I get the following error -
I tried the latest build from github (2.0.1-SNAPSHOT) locally and got a the same error. I even created a docker image and built the jar, but got a different error -