diff --git a/docs/index.md b/docs/index.md index 64e25ef..10076c2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,7 +38,8 @@ PanMAN utilizes Google’s protocol buffer (protobuf, [https://protobuf.dev/](ht ### Video Tutorial TBA -## Installation Methods + +## panmanUtils Installation Methods ### Using installation script (requires sudo access) @@ -112,12 +113,12 @@ docker run -it panman cd /home/panman/build ./panmanUtils --help ``` - + ## PanMAN Construction Here, we will learn to build PanMAN from various input formats. -**Step 0:** The Steps below require panmanUtils, if not done so far, refer to [installation guide](install.md) to install panmanUtils. To check if panmanUtils is properly installed or not, run the following command, and it should execute without error +**Step 0:** The Steps below require panmanUtils, if not done so far, refer to [installation guide](#install) to install panmanUtils. To check if panmanUtils is properly installed or not, run the following command, and it should execute without error ```bash # enter into the panman directory (assuming $PANMAN directs to the panman repository directory) cd $PANMAN_HOME @@ -126,8 +127,8 @@ cd $PANMAN_HOME cd $PANMAN_HOME/build ./panmanUtils --help ``` -### Building PanMAN from PanGraph - +### Building PanMAN from Alignments (PanGraph/GFA/MSA) +#### Building PanMAN from PanGraph **Step 1:** Check if `sars_20.json` and `sars_20.nwk` files exist in `test` directory. Alternatively, users can provide custom PanGraph (JSON) and tree topology (Newick format) files to build a panman. **Step 2:** Run panmanUtils with the following command to build a panman from PanGraph: @@ -138,7 +139,7 @@ cd $PANMAN_HOME/build ``` The above command will run panmanUtils program and build `sars_20.panman` in `$PANMAN_HOME/build/panman` directory. -### Building PanMAN from GFA +#### Building PanMAN from GFA **Step 1:** Check if `sars_20.gfa` and `sars_20.nwk` files exist in `test` directory. Alternatively, users can provide custom GFA and tree topology (Newick format) files to build a panman. @@ -150,7 +151,7 @@ cd $PANMAN_HOME/build ``` The above command will run panmanUtils program and build `sars_20.panman` in `$PANMAN_HOME/build/panman` directory. -### Building PanMAN from MSA (FASTA format) +#### Building PanMAN from MSA (FASTA format) **Step 1:** Check if `sars_20.msa` and `sars_20.nwk` files exist in `test` directory. Alternatively, users can provide custom MSA (FASTA format) and tree topology (Newick format) files to build a panman. @@ -162,25 +163,36 @@ cd $PANMAN_HOME/build ``` The above command will run panmanUtils program and build `sars_20.panman` in `$PANMAN_HOME/build/panman` directory. -### Building PanMAN from raw genome sequences (Snakemake Workflow) -We provide a Snakemake workflow to construct PanMANs from raw sequences (FASTA format). +### Building PanMAN from raw genome sequences or fragment assemblies using Snakemake Workflow +We provide a Snakemake workflow to construct PanMANs from raw sequences (FASTA format) or from fragment assemblies. !!!Note - The Snakemake workflow uses various tools such as PanGraph tool, PGGB, MAFFT, and MashTree to build input PanGraph, GFA, MSA, and Tree topology files, respectively and it is particularly designed to be used in the docker container build from either the provided docker image or the DockerFile (instructions provided [here](install.md)). + The Snakemake workflow uses various tools such as PanGraph tool, PGGB, MAFFT, and MashTree to build input PanGraph, GFA, MSA, and Tree topology files, respectively and it is particularly designed to be used in the docker container build from either the provided docker image or the DockerFile (instructions provided [here](#install)). +#### Building PanMAN from raw genome sequences **Step 1:** Run the following command to construct a panman from raw sequences. ```bash cd $PANMAN_HOME/workflows conda activate snakemake -snakemake --use-conda --cores [num threads] --config RUNTYPE="[pangraph/gfa/msa]" FASTA="[user_fasta]" SEQ_COUNT=[haplotype_count] +snakemake --use-conda --cores 8 --config RUNTYPE="pangraph/gfa/msa" FASTA="[user_input]" SEQ_COUNT="Number of sequences" ASSEM="NONE" REF="NONE" TARGET="NONE" +``` + +#### Building PanMAN from fragment assemblies +**Step 1:** Run the following command to construct a panman from fragment assemblies. + +```bash +cd $PANMAN_HOME/workflows +conda activate snakemake +snakemake --use-conda --cores 8 --config RUNTYPE="pangraph/gfa/msa" FASTA="None" SEQ_COUNT="Number of sequences" ASSEM="frag" REF="reference_file" TARGET="target.txt" ``` +Here, target.txt contains list of files that contains the fragmented assemblies. ## Exploring utilities in panmanUtils Here, we will learn to use exploit various functionalities provided in panmanUtils software for downstream applications in epidemiological, microbiological, metagenomic, ecological, and evolutionary studies. -**Step 0:** The Steps below require panmanUtils and a PanMAN. We provide a pre-built panman (`sars_20.panman`), othewise, refer to [installation guide](install.md) to install panmanUtils and [construction](construction.md) instructions to build a PanMAN. +**Step 0:** The Steps below require panmanUtils and a PanMAN. We provide a pre-built panman (`sars_20.panman`), othewise, refer to [installation guide](#install) to install panmanUtils and [construction](#construction) instructions to build a PanMAN.