Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
codeatcg authored Feb 20, 2023
1 parent 1d881c9 commit 56af935
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ g++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) minipg.
# Prepare your data

## Pangenome graph already exists
The naming scheme of assembly should follow <a href="https://github.com/pangenome/PanSN-spec">PanSN prefix naming pattern</a>. Briefly, the assemblys name consists of sample name, delimiter, and haplotype name, e.g., sampleA#0. But its a little looser in VRPG. Its not required that the haplotype name must be numeric, characters are also allowed. The assemblies to graph mapping files are also required. If these files do not exist the assembly cant be highlighted in the drawing. These files can be generated by minigraph by using command -cxasm --vc. Then run the following command to get files required by VRPG.
The naming scheme of assembly should follow <a href="https://github.com/pangenome/PanSN-spec">PanSN prefix naming pattern</a>. Briefly, the assembly's name consists of sample name, delimiter, and haplotype name, e.g., sampleA#0. But it's a little looser in VRPG. It's not required that the haplotype name must be numeric, characters are also allowed. The assemblies to graph mapping files are also required. If these files do not exist the assembly can't be highlighted in the drawing. These files can be generated by minigraph by using command '-cxasm --vc'. Then run the following command to get files required by VRPG.

```
Python script/vrpg_preprocess.py --rGFA all.gfa --gafList gaf_file.list --outDir out_folder --index
Expand All @@ -46,7 +46,7 @@ sample3#2 sample3.2.gaf
Run the following command to create pangenome graph and generate files required by VRPG.

```
Python script/vrpg_preprocess.py –-minigraph /software/minigraph --assList ass_file.list –-outDir out_folder --index
Python script/vrpg_preprocess.py –-minigraph '/software/minigraph' --assList ass_file.list –-outDir out_folder --index
```

### ass_file.list file is formatted as follows:
Expand All @@ -55,11 +55,11 @@ sample2#0 sample2.0.fa
sample3#1 sample3.1.fa
sample3#2 sample3.2.fa

*Note*, /software/minigraph represents the absolute path of minigraph executable file. Assembly in first line in file ass_file.list will be taken as reference.
*Note*, '/software/minigraph' represents the absolute path of minigraph executable file. Assembly in first line in file ass_file.list will be taken as reference.


# Execution
1. Move all output files in directory upload generated during data preparation to the empty folder upload of VRPG.
1. Move all output files in directory 'upload' generated during data preparation to the empty folder 'upload' of VRPG.
2. Start the development server of Django

```
Expand Down

0 comments on commit 56af935

Please sign in to comment.