docs/refinepeak.md

   1 # Refinepeak
   2
   3 ## Overview
   4 The `refinepeak` command is part of the MACS3 suite of tools and is used to refine peak summits. It is particularly useful in ChIP-Seq analysis where refining the peak summits can lead to more accurate results.
   5
   6 ## Detailed Description
   7
   8 The `refinepeak` command takes in a BED file containing peaks and produces an output BED file with refined peak summits. It uses an efficient algorithm to refine the peak summits, improving the quality of your data for further analysis.
   9
  10 ## Command Line Options
  11
  12 The command line options for `refinepeak` are defined in `/MACS3/Commands/refinepeak_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 BED format. This option is required and can take multiple files.
  15 - `-o` or `--ofile`: The output file. This will be in BED format.
  16 - `-g` or `--gsize`: The size of the genome. Can be an integer or a string like '2.7e9'. Default is 'hs' for human genome size.
  17 - `-n` or `--name`: The name string of the experiment. This will be used to generate output file names. Default is 'NA'.
  18 - `--bw`: The bandwidth used to compute the fragment size. Default is 300.
  19 - `--fix-bimodal`: If set, MACS will not model but use the user-determined fragment size.
  20 - `--nomodel`: If set, MACS will not build the shifting model.
  21 - `--extsize`: While '--nomodel' is set, MACS uses this parameter to extend reads in 5'->3' direction to fix-sized fragments.
  22
  23 ## Example Usage
  24
  25 Here is an example of how to use the `refinepeak` command:
  26
  27 ```bash
  28 macs3 refinepeak -i peaks.bed -o refined_peaks.bed -g hs -n experiment1 --bw 300 --nomodel
  29 ```
  30
  31 In this example, the program will refine the peak summits in the `peaks.bed` file and write the result to `refined_peaks.bed`. The genome size is set to 'hs' (human), the name of the experiment is 'experiment1', the bandwidth is set to 300, and the shifting model is not built.
  32
  33 ## FAQs about `refinepeak`
  34
  35 Q: What does `refinepeak` do?
  36 A: `refinepeak` is a tool in the MACS3 suite that refines peak summits. It is useful in ChIP-Seq analysis where refining the peak summits can lead to more accurate results.
  37
  38 Q: How do I use `refinepeak`?
  39 A: You can use `refinepeak` by providing it with an input BED file, an output file, and various other options as required. See the [Example Usage](#example-usage) section above for an example of how to use `refinepeak`.
  40
  41 ## Troubleshooting `refinepeak`
  42
  43 If you're having trouble using `refinepeak`, here are some things to try:
  44
  45 - Make sure your input file is in the correct format. `refinepeak` requires a BED file.
  46 - Make sure the parameters you provide are appropriate for your data. Different parameters will yield different results.
  47
  48 ## Known issues or limitations of `refinepeak`
  49
  50 As of now, there are no known issues or limitations with `refinepeak`. If you encounter a problem, please submit an issue on the MACS3 GitHub page.