deeptools / HiCExplorer

HiCExplorer is a powerful and easy to use set of tools to process, normalize and visualize Hi-C data.
https://hicexplorer.readthedocs.org
GNU General Public License v3.0
231 stars 70 forks source link

Misleading Documentation for --tadDomains, -td Parameter in hicDifferentialTAD Tool #904

Open GuanrongYan opened 1 month ago

GuanrongYan commented 1 month ago

Description: The current documentation and example provided for the hicDifferentialTAD tool might be misleading regarding the interpretation of the --tadDomains, -td parameter. According to the description, it's stated that this parameter should point to the TAD domains file computed by hicFindTADs from the treatment (experimental) dataset. However, the example provided seems to contradict this understanding by pointing to a TAD domains file (untreated_R1_domains.bed) that suggests it might be from the control (untreated) dataset instead.

Example Provided:

css Copy code $ hicDifferentialTAD -tm GSM2644945_Untreated-R1.100000_chr1.cool \ -cm GSM2644947_Auxin2days-R1.100000_chr1.cool \ -td untreated_R1_domains.bed \ -o differential -p 0.01 -t 4 -mr all Expected Clarification: Could the documentation be clarified to explicitly state that the --tadDomains, -td parameter should indeed refer to the TAD domains file computed from the treatment (experimental) dataset using hicFindTADs? This would ensure consistency and prevent confusion among users regarding which dataset's TAD domains file should be used in the analysis.

Thank you for considering this feedback. Please let me know if any further clarification or information is needed.