docs/bdgdiff.md

   1 # Bdgdiff
   2
   3 ## Overview
   4 The `bdgdiff` command is part of the MACS3 suite of tools and is used to call differential peaks from four bedGraph tracks for scores. It is particularly useful in ChIP-Seq analysis for identifying differential peaks in the data.
   5
   6 ## Detailed Description
   7
   8 The `bdgdiff` command takes four input bedGraph files (two treatment and two control files) and produces three output files with differential peaks called. It uses an efficient algorithm to detect and call differential peaks, greatly improving the quality of your data for further analysis.
   9
  10 ## Command Line Options
  11
  12 The command line options for `bdgdiff` are defined in `/MACS3/Commands/bdgdiff_cmd.py` and `/bin/macs3` files. Here is a brief overview of these options:
  13
  14 - `-t1` or `--t1bdg`: The first treatment file. This should be in bedGraph format. This option is required.
  15 - `-c1` or `--c1bdg`: The first control file. This should be in bedGraph format. This option is required.
  16 - `-t2` or `--t2bdg`: The second treatment file. This should be in bedGraph format. This option is required.
  17 - `-c2` or `--c2bdg`: The second control file. This should be in bedGraph format. This option is required.
  18 - `-d1` or `--depth1`: The depth of the first condition. This is a float value.
  19 - `-d2` or `--depth2`: The depth of the second condition. This is a float value.
  20 - `-o` or `--ofile`: The output file. This will be in bedGraph format.
  21 - `-m` or `--minlen`: The minimum length of differential peaks. This is an integer value.
  22 - `-g` or `--maxgap`: The maximum gap between differential peaks. This is an integer value.
  23 - `-c` or `--cutoff`: The cutoff for LLR to call differential peaks. This is a float value.
  24
  25 ## Example Usage
  26
  27 Here is an example of how to use the `bdgdiff` command:
  28
  29 ```bash
  30 macs3 bdgdiff -t1 treatment1.bedGraph -c1 control1.bedGraph -t2 treatment2.bedGraph -c2 control2.bedGraph --depth1 1.0 --depth2 1.0 -o output.bedGraph --minlen 500 --maxgap 1000 --cutoff 1.0
  31 ```
  32
  33 In this example, the program will call differential peaks from the two pairs of treatment and control bedGraph files and write the result to `output.bedGraph`. The depth of the first and second condition is set to 1.0, the minimum length of differential peaks is set to 500, the maximum gap between differential peaks is set to 1000, and the cutoff for LLR to call differential peaks is set to 1.0.
  34
  35 ## FAQs about `bdgdiff`
  36
  37 Q: What does `bdgdiff` do?
  38 A: `bdgdiff` is a tool in the MACS3 suite that calls differential peaks from four bedGraph tracks for scores. It is useful in ChIP-Seq analysis for identifying differential peaks in the data.
  39
  40 Q: How do I use `bdgdiff`?
  41 A: You can use `bdgdiff` by providing it with four input files (two treatment and two control), 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 `bdgdiff`.
  42
  43 ## Troubleshooting `bdgdiff`
  44
  45 If you're having trouble using `bdgdiff`, here are some things to try:
  46
  47 - Make sure your input files are in the correct format. `bdgdiff` requires four bedGraph format files.
  48 - Make sure the values you provide for depth, minlen, maxgap, and cutoff are appropriate for your data. If the values are too small or too large, you may get inaccurate results.
  49
  50 ## Known issues or limitations of `bdgdiff`
  51
  52 As of now, there are no known issues or limitations with `bdgdiff`. If you encounter a problem, please submit an issue on the MACS3 GitHub page.