Skip to content

Commit

Permalink
Correcting README
Browse files Browse the repository at this point in the history
  • Loading branch information
senkin committed Dec 1, 2023
1 parent d8cc901 commit 8358975
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,25 @@ Make sure you have the following dependencies installed before running the pipel

## Input

The directory with input VCF files specified by the `params.input_folder_with_VCF_files` parameter (by default, `./VCFs/*vcf.gz`)
| Name | Default value | Description |
|-----------|---------------|-----------------|
| `--output_foinput_folder_with_VCF_fileslder` | `${baseDir}/VCFs/` | Folder containing `*vcf.gz` files |


## Parameters

* #### Optional

| Name | Default value | Description |
|-----------|---------------|-----------------|
| `--reference_genome` | `GRCh37.75` | Folder containing `*vcf.gz` files |
| `--dbNSF_path` | `${baseDir}/dbNSFP4.1a.txt.gz` | [dbNSFP database](https://pcingola.github.io/SnpEff/ss_dbnsfp/) |
| `--dbSNP_path` | `${baseDir}/dbsnp150.vcf.gz` | [dbSNP database](https://ftp.ncbi.nlm.nih.gov/snp/organisms) |
| `--output_path` | `${baseDir}/output` | Output folder |

## Output

The final annotated and extracted information will be available in the `output` directory as `full_annotation.txt`.
The final annotated and extracted information will be available in the output directory as `full_annotation.txt`.

## Customization

Expand Down

0 comments on commit 8358975

Please sign in to comment.