AnantharamanLab / VIBRANT

Virus Identification By iteRative ANnoTation
GNU General Public License v3.0
142 stars 37 forks source link

Command line arguments #10

Closed SilasK closed 4 years ago

SilasK commented 4 years ago

Dear Developpers, here just some personal feedback on the VIBRANT cli.

How you could make the CLI simpler for the users.

I'm using version VIBRANT v1.0.1

Vibrant has a lot of options to specify the databases. Do you think this could be collapsed in one --db argument.

Ideally the script download-db.sh should have 1 argument where to put all the databases.


  -k K            path to KEGG HMMs (if moved from default location)
  -p P            path to Pfam HMMs (if moved from default location)
  -v V            path to VOG HMMs (if moved from default location)
  -e E            path to plasmid HMMs (if moved from default location)
  -a A            path to viral-subset Pfam HMMs (if moved from default location)
  -c C            path to VIBRANT categories file (if moved from default location)
  -n N            path to VIBRANT annotation to name file (if moved from default location)
  -s S            path to VIBRANT summary of KEGG metabolism file (if moved from default location)
  -m M            path to VIBRANT neural network machine learning model (if moved from default location)
  -g G            path to VIBRANT AMGs file (if moved from default location)
KrisKieft commented 4 years ago

Hi Silas,

You shouldn't need to specify these database locations. This is only if you move around the original parent directory. That said, I can look into collapsing them. As for the download-db.sh script, you shouldn't need to add any arguments. They download to a default location. This is what bioconda provided for VIBRANT and is not necessarily the most ideal procedure. VIBRANT was originally built for an easy git clone. I appreciate all questions/comments so please feel free to let me know if you have any other thoughts.

Kris

SilasK commented 4 years ago

Thank you for your quick response. I don’t like default locations.