docs/bdgbroadcall.md

   1 # Bdgbroadcall
   2
   3 ## Overview
   4 The `bdgbroadcall` command is part of the MACS3 suite of tools and is used to call broad peaks from a single bedGraph track for scores. It is particularly useful in ChIP-Seq analysis for identifying broad peaks in the data.
   5
   6 ## Detailed Description
   7
   8 The `bdgbroadcall` command takes an input bedGraph file and produces an output file with broad peaks called. It uses an efficient algorithm to detect and call broad peaks, greatly improving the quality of your data for further analysis.
   9
  10 ## Command Line Options
  11
  12 The command line options for `bdgbroadcall` are defined in `/MACS3/Commands/bdgbroadcall_cmd.py` and `/bin/macs3` files. Here is a brief overview of these options:
  13
  14 - `-i` or `--ifile`: The input file. This should be in bedGraph format. This option is required.
  15 - `-o` or `--ofile`: The output file. This will be in the same format as the input file. This option is required.
  16 - `-c` or `--cutoff`: The cutoff value for calling peaks. This is a float value.
  17 - `-l` or `--minlen`: The minimum length of peaks. This is an integer value.
  18 - `-g` or `--maxgap`: The maximum gap between peaks. This is an integer value.
  19 - `-C` or `--cutofflink`: The cutoff value for linking peaks. This is a float value.
  20 - `-L` or `--maxgaplink`: The maximum gap for linking peaks. This is an integer value.
  21
  22 ## Example Usage
  23
  24 Here is an example of how to use the `bdgbroadcall` command:
  25
  26 ```bash
  27 macs3 bdgbroadcall -i input.bedGraph -o output.bedGraph --cutoff 1.0 --minlen 500 --maxgap 1000 --cutofflink 1.5 --maxgaplink 500
  28 ```
  29
  30 In this example, the program will call broad peaks from the `input.bedGraph` file and write the result to `output.bedGraph`. The cutoff value for calling peaks is set to 1.0, the minimum length of peaks is set to 500, the maximum gap between peaks is set to 1000, the cutoff value for linking peaks is set to 1.5, and the maximum gap for linking peaks is set to 500.
  31
  32 ## FAQs about `bdgbroadcall`
  33
  34 Q: What does `bdgbroadcall` do?
  35 A: `bdgbroadcall` is a tool in the MACS3 suite that calls broad peaks from a single bedGraph track for scores. It is useful in ChIP-Seq analysis for identifying broad peaks in the data.
  36
  37 Q: How do I use `bdgbroadcall`?
  38 A: You can use `bdgbroadcall` by providing it with an input file, an output file, and optional parameters that control its behavior. See the [Example Usage](#example-usage) section above for an example of how to use `bdgbroadcall`.
  39
  40 ## Troubleshooting `bdgbroadcall`
  41
  42 If you're having trouble using `bdgbroadcall`, here are some things to try:
  43
  44 - Make sure your input file is in the correct format. `bdgbroadcall` requires a bedGraph format file.
  45 - Make sure the values you provide for cutoff, minlen, maxgap, cutofflink, and maxgaplink are appropriate for your data. If the values are too strict, you may not get any peaks. If the values are too loose, you may get too many peaks.
  46
  47 ## Known issues or limitations of `bdgbroadcall`
  48
  49 As of now, there are no known issues or limitations with `bdgbroadcall`. If you encounter a problem, please submit an issue on the MACS3 GitHub page.