From 5d2b83c950885be51d4360229eeedd16c428a242 Mon Sep 17 00:00:00 2001 From: Tovah Markowitz Date: Thu, 21 Nov 2024 12:17:59 -0500 Subject: [PATCH] Update run.md --- docs/usage/run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/run.md b/docs/usage/run.md index bd6c4ef..324aef2 100644 --- a/docs/usage/run.md +++ b/docs/usage/run.md @@ -72,7 +72,7 @@ Each of the following arguments are required. Failure to provide a required argu > **Peakcall file.** > *type: file* > -> This tab delimited (TSV) file is used to pair each ChIP sample to its corresponding input sample and to assign any groups that are associated with said sample. Please note that multiple groups can be assigned to a given sample using a comma. Group information is used to setup comparsions within groups of samples. This file consists of three columns containing the name of each ChIP sample, the name of each Input (control) sample, and the name of its groups. Each sample must be assigned to at least one group. The header of this file needs to be `ChIP` for the chips column, `Input` for the inputs column, and `Group` for the groups column. The base name of each sample should be listed in the `ChIP` and `Input` columns. The base name of a given sample can be determined by removing its file extension from the sample's R1 FastQ file, example: `WT_S4.R1.fastq.gz` becomes `WT_S4` in the peakcall file. `WT_S4_R1_001.fastq.gz` also becomes `WT_S4`. An optional column, called Block, can also be provided to block duplicate correlations between repeated observations. Typically, blocks are biological replicates or multiple samples from same indivdual. +> This tab delimited (TSV) file is used to pair each ChIP sample to its corresponding input sample and to assign any groups that are associated with said sample. Please note that multiple groups can be assigned to a given sample using a comma. Group information is used to setup comparsions within groups of samples. This file consists of three columns containing the name of each ChIP sample, the name of each Input (control) sample, and the name of its groups. Each sample must be assigned to at least one group. The header of this file needs to be `ChIP` for the chips column, `Input` for the inputs column, and `Group` for the groups column. Group names currently cannot include ".", "-", or "_". The base name of each sample should be listed in the `ChIP` and `Input` columns. The base name of a given sample can be determined by removing its file extension from the sample's R1 FastQ file, example: `WT_S4.R1.fastq.gz` becomes `WT_S4` in the peakcall file. `WT_S4_R1_001.fastq.gz` also becomes `WT_S4`. An optional column, called Block, can also be provided to block duplicate correlations between repeated observations. Typically, blocks are biological replicates or multiple samples from same indivdual. > > **Contents of example peakcalls file:** > ```