Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
GuanrongYan opened this issue Jul 18, 2024 · 0 comments

Comments

@GuanrongYan
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant