mycobactopia-org / MTBseq-nf

MTBSeq made simple and easy using Nextflow and nf-core standard.
https://doi.org/10.5281/zenodo.5498063
MIT License
8 stars 1 forks source link

Create a documentation website #35

Open abhi18av opened 2 years ago

abhi18av commented 2 years ago

I've added a brief section for brief section for usage instruction.

https://github.com/mtb-bioinformatics/mtbseq-nf#usage

But it might be worth to think about a docusaurus website for mtb-bioinformatics and then showcase the options for mtbseq-nf

abhi18av commented 2 years ago

Note:

The docker image contains the following references


$ docker run -it --rm quay.io/biocontainers/mtbseq:1.0.3--pl526_1

/ # ls /usr/local/share/mtbseq-1.0.3-1/var/ref/ -lah
total 30568
drwxr-xr-x    2 root     root        4.0K Oct  4  2018 .
drwxr-xr-x    5 root     root        4.0K Oct  4  2018 ..
-rw-rw-r--    1 root     root        4.8M Oct  4  2018 M._abscessus_CIP-104536T_2014-02-03.fasta
-rw-rw-r--    1 root     root      475.1K Oct  4  2018 M._abscessus_CIP-104536T_2014-02-03_genes.txt
-rw-rw-r--    1 root     root        5.6M Oct  4  2018 M._chimaera_DSM44623_2016-01-28.fasta
-rw-rw-r--    1 root     root      546.5K Oct  4  2018 M._chimaera_DSM44623_2016-01-28_genes.txt
-rw-rw-r--    1 root     root        6.0M Oct  4  2018 M._fortuitum_CT6_2016-01-08.fasta
-rw-rw-r--    1 root     root      512.2K Oct  4  2018 M._fortuitum_CT6_2016-01-08_genes.txt
-rw-rw-r--    1 root     root         203 Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.dict
-rw-rw-r--    1 root     root        4.2M Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta
-rw-rw-r--    1 root     root          12 Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta.amb
-rw-rw-r--    1 root     root          60 Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta.ann
-rw-rw-r--    1 root     root        4.2M Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta.bwt
-rw-rw-r--    1 root     root          48 Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta.fai
-rw-rw-r--    1 root     root        1.1M Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta.pac
-rw-rw-r--    1 root     root        2.1M Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13.fasta.sa
-rw-rw-r--    1 root     root      344.7K Oct  4  2018 M._tuberculosis_H37Rv_2015-11-13_genes.txt
abhi18av commented 2 years ago

Partially done with #43

abhi18av commented 2 years ago

I've initied the repo here https://github.com/mtb-bioinformatics/mtb-boinformatics.github.io