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

Create a documentation website #35

Open
abhi18av opened this issue Sep 8, 2021 · 3 comments
Open

Create a documentation website #35

abhi18av opened this issue Sep 8, 2021 · 3 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@abhi18av
Copy link
Member

abhi18av commented Sep 8, 2021

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 abhi18av self-assigned this Sep 8, 2021
@abhi18av abhi18av linked a pull request Sep 9, 2021 that will close this issue
@abhi18av abhi18av removed a link to a pull request Sep 9, 2021
@abhi18av
Copy link
Member Author

abhi18av commented Sep 20, 2021

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
Copy link
Member Author

Partially done with #43

@emilyncosta emilyncosta self-assigned this Sep 23, 2021
@abhi18av abhi18av added the help wanted Extra attention is needed label Sep 24, 2021
@abhi18av abhi18av changed the title Write a usage manual Create a documentation website Oct 21, 2021
@abhi18av
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants