Skip to content

Commit 2ad0116

Browse files
authored
chore(main): Update config/README.md
1 parent e438416 commit 2ad0116

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

Diff for: config/README.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1-
Describe how to configure the workflow (using config.yaml and maybe additional files).
2-
All of them need to be present with example entries inside of the config folder.
3-
4-
In config/config.yml:
5-
* Add the name of the folder containing the bamfiles under data/folder
1+
The starting point of the pipeline are .bam files from one or more RNA samples. They are assumed to have been already sequenced.
2+
Edit the config/config.yml file as follows:
3+
* data:
4+
1) ["folder"]: path to the folder containing the .bam files
5+
* reference:
6+
1) ["folder"]: the folder containing the .fa file
7+
2) ["genome"]: the genome file
8+
* known_sites: used only in FreeBayes, and not GATK's HaplotypeCaller. Currently not used
9+
* filtering:
10+
1) ["params"]: the parameters for bcftools filter. An example is provided
11+
* vep:
12+
1) cache_dir: directory in which the VEP cache should be downloaded
13+
2) zip_name: name of the zip file to download
14+
3) url: complete URL of the file to download
15+
4) image: docker image on which to create a container with Docker or Singularity
16+
5) filters: "--filter "
17+
6) impact_levels: select the impact level, as a list of strings (ex. ["MODERATE", "HIGH"]
18+
7) species: currently only needed to give a directory name

0 commit comments

Comments
 (0)