SWittouck / SCARAP

A toolkit for prokaryotic comparative genomics
GNU General Public License v3.0
26 stars 5 forks source link

Start a wiki #25

Open SWittouck opened 1 year ago

SWittouck commented 1 year ago

Make a "quick start" section in the main README file and move demonstrations of more complicated analyses to a GitHub wiki.

Example of a more complicated analysis to explain in the wiki: creating a pangenome profile database for a hierarchical pangenome (see LEGEN pipeline for a detailed example):

  1. Gather the pseudogenome sequences with the fetch module.
  2. Build the profile database using the pseudopangenome (part of the hierarchical pan module output) and the pseudogenome sequences.
SWittouck commented 1 year ago

In the wiki, the input and output files of all modules should be explained in detail.

E.g., the output of the hierarchical pan module: