diff --git a/README.md b/README.md index e9b096d6c251954124bd8c13fd6046237e0ab423..7b63bf5c6915c846afa2629d145da2bf4f49ed43 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,33 @@ Design columns: Link to an Example: [design.txt](https://gitlab.pasteur.fr/hub/ePeak/-/blob/master/test/design.txt) +**Example of config file and associated fastq file:** + +For an experiment with one mark (H3K27ac) and 2 conditions (shCtrl and shUbc9) in duplicates, except for one INPUT which have failed. The list of fastq is the following : + +``` +H3K27ac_shCtrl_rep1_R1.fastq.gz +H3K27ac_shCtrl_rep2_R1.fastq.gz +INPUT_shCtrl_rep1_R1.fastq.gz +H3K27ac_shUbc9_rep1_R1.fastq.gz +H3K27ac_shUbc9_rep2_R1.fastq.gz +INPUT_shUbc9_rep1_R1.fastq.gz +INPUT_shUbc9_rep2_R1.fastq.gz + +``` +For this experiment, the config file should be : + +``` +IP_NAME INPUT_NAME NB_IP NB_INPUT +H3K27ac_shCtrl INPUT_shCtrl 1 1 +H3K27ac_shCtrl INPUT_shCtrl 2 1 +H3K27ac_shUbc9 INPUT_shUbc9 1 1 +H3K27ac_shUbc9 INPUT_shUbc9 2 2 +``` + +IP of the first condition are linked to the unique INPUT, and each IP file of second condition is linked to his INPUT. + + ### How to fill the config file All the parameters to run the pipeline are gathered in a YAML config file that the user has to fill before running the pipeline. Here is an filled example: [config.yaml](https://gitlab.pasteur.fr/hub/ePeak/-/blob/master/test/config.yaml)