docs/cmbreps.md

   1 # Cmbreps
   2
   3 ## Overview
   4 The `cmbreps` command is part of the MACS3 suite of tools and is used to combine replicate bedGraph files. It is particularly useful in ChIP-Seq analysis where multiple replicates of the same experiment are performed.
   5
   6 ## Detailed Description
   7
   8 The `cmbreps` command takes a list of input bedGraph files (replicates) and produces an output file with combined scores. It uses an efficient algorithm to combine the scores of the replicates, greatly improving the quality of your data for further analysis.
   9
  10 ## Command Line Options
  11
  12 The command line options for `cmbreps` are defined in `/MACS3/Commands/cmbreps_cmd.py` and `/bin/macs3` files. Here is a brief overview of these options:
  13
  14 - `-i` or `--ifile`: The input files. These should be in bedGraph format. This option is required and can take multiple files.
  15 - `-o` or `--ofile`: The output file. This will be in bedGraph format.
  16 - `-m` or `--method`: The method to use for combining scores. This can be one of the following: `mean`, `median`, `min`, `max`, `sum`, `p_norm`.
  17
  18 ## Example Usage
  19
  20 Here is an example of how to use the `cmbreps` command:
  21
  22 ```bash
  23 macs3 cmbreps -i replicate1.bedGraph replicate2.bedGraph replicate3.bedGraph -o combined.bedGraph --method mean
  24 ```
  25
  26 In this example, the program will combine the scores in the `replicate1.bedGraph`, `replicate2.bedGraph`, and `replicate3.bedGraph` files and write the result to `combined.bedGraph`. The method used for combining scores is `mean`.
  27
  28 ## FAQs about `cmbreps`
  29
  30 Q: What does `cmbreps` do?
  31 A: `cmbreps` is a tool in the MACS3 suite that combines replicate bedGraph files. It is useful in ChIP-Seq analysis where multiple replicates of the same experiment are performed.
  32
  33 Q: How do I use `cmbreps`?
  34 A: You can use `cmbreps` by providing it with a list of input files (replicates), an output file, and a method for combining scores. See the [Example Usage](#example-usage) section above for an example of how to use `cmbreps`.
  35
  36 ## Troubleshooting `cmbreps`
  37
  38 If you're having trouble using `cmbreps`, here are some things to try:
  39
  40 - Make sure your input files are in the correct format. `cmbreps` requires bedGraph format files.
  41 - Make sure the method you provide for combining scores is appropriate for your data. Different methods will produce different combined scores.
  42
  43 ## Known issues or limitations of `cmbreps`
  44
  45 As of now, there are no known issues or limitations with `cmbreps`. If you encounter a problem, please submit an issue on the MACS3 GitHub page.