Skip to content

Commit 0436058

Browse files
Further explanations in usage
1 parent f83b1d6 commit 0436058

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

docs/usage.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,13 @@ WT_INPUT,BLA203A30_S21_L002_R1_001.fastq.gz,,2,,,
4747
WT_INPUT,BLA203A31_S21_L003_R1_001.fastq.gz,,3,,,
4848
```
4949

50-
### Note on IP and control replicates
50+
### Note on IP and control replicates - Comparisons of one IP sample against multiple controls
5151

5252
The pipeline is designed to handle one IP and matching control replicate, see section above. However there can be
5353
situations where one might want to make multiple comparisons of the IP sample against several different controls. In
54-
those cases it is advisable to encode these comparisons either in the sample column or as another replicate.
54+
those cases it is advisable to encode these comparisons either in the sample column or as another replicate. Since it is
55+
rather unusual in ChIP-Seq experiments, this feature is considered experimental. Please open a github issue in case you
56+
need further assistance.
5557

5658
- Encoding in sample names:
5759

@@ -119,15 +121,15 @@ NAIVE_INPUT,BLA203A48_S39_L001_R1_001.fastq.gz,,2,,,
119121
NAIVE_INPUT,BLA203A49_S1_L006_R1_001.fastq.gz,,3,,,
120122
```
121123

122-
| Column | Description |
123-
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
124-
| `sample` | Custom sample name. This entry will be identical for multiple sequencing libraries/runs from the same sample. Spaces in sample names are automatically converted to underscores (`_`). It should be unique and contain the antibody name. E.g: `{Treatment or cell type}_{antibody}_IP` |
125-
| `fastq_1` | Full path to FastQ file for Illumina short reads 1. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
126-
| `fastq_2` | Full path to FastQ file for Illumina short reads 2. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
127-
| `replicate` | Integer representing replicate number. This will be identical for re-sequenced libraries. Must start from `1..<number of replicates>`. |
128-
| `antibody` | Antibody name. This is required to segregate downstream analysis for different antibodies. Required when `control` is specified. |
129-
| `control` | Sample name for control sample. |
130-
| `control_replicate` | Integer representing replicate number for control sample. |
124+
| Column | Description |
125+
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
126+
| `sample` | Custom sample name. This entry will be identical for multiple sequencing libraries/runs from the same sample. Spaces in sample names are automatically converted to underscores (`_`). It should be unique per sample and contain sufficient informations, such as the antibody name. E.g: `{Treatment or cell type}_{antibody}_IP` -> `{WT/NAIVE}_{BCATENIN}_IP` |
127+
| `fastq_1` | Full path to FastQ file for Illumina short reads 1. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
128+
| `fastq_2` | Full path to FastQ file for Illumina short reads 2. File has to be gzipped and have the extension ".fastq.gz" or ".fq.gz". |
129+
| `replicate` | Integer representing replicate number. This will be identical for re-sequenced libraries. Must start from `1..<number of replicates>`. |
130+
| `antibody` | Antibody name. This is required to segregate downstream analysis for different antibodies. Required when `control` is specified. |
131+
| `control` | Sample name for control sample. |
132+
| `control_replicate` | Integer representing replicate number for control sample. |
131133

132134
Example design files have been provided with the pipeline for [paired-end](../assets/samplesheet_pe.csv) and [single-end](../assets/samplesheet_se.csv) data.
133135

0 commit comments

Comments
 (0)