AdamaJava / adamajava

Other
14 stars 5 forks source link

create new qpileup document #274

Closed ChristinaXu2017 closed 2 years ago

ChristinaXu2017 commented 3 years ago

Description

New documentation (readthedocs.io) for qpileup is created due to the updating of Qpileup command line usage and INI options, and the Previous document is archived. This new document is for the latest Adamajava which is not yet released.

Type of change

Documentation

How Has This Been Tested?

No testing required

Are WDL Updates Required?

n/a

Checklist:

n/a

ChristinaXu2017 commented 3 years ago

What was the thinking behind the reorganisation into different files?

There were several different files, one for each mode. Now I integrated them into one file (index.md). Tred to add more detailed examples for each mode and more explanation of HDF files, just feel the one file is too big to read. I also use qbamfilter docs as an example, it adds query examples into a separate file.