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

Start a wiki #25

Open
SWittouck opened this issue Apr 4, 2023 · 1 comment
Open

Start a wiki #25

SWittouck opened this issue Apr 4, 2023 · 1 comment

Comments

@SWittouck
Copy link
Owner

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

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:

  • speciespangenomes: species-level orthogroups of all genes
  • pseudogenomes.tsv: representative genes of species-level orthogroups; format structured in such a way that representative sequences can be gathered with the fetch module
  • pseudopangenome.tsv: pangenome of the pseudogenomes
  • pangenome.tsv: overall pangenome

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant