Skip to content

docs(motif): clarify motif enrichment outputs and interpretation - #146

Merged
kopardev merged 5 commits into
mainfrom
issue_129
Sep 25, 2026
Merged

kopardev merged 5 commits into
mainfrom
issue_129

Conversation

@kopardev

@kopardev kopardev commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Changes

  • Correct the docs so motif enrichment outputs are described under their real location in results/peaks/.../*_motif_enrichment/, not as QC outputs.
  • Expand motif-enrichment documentation for junior users by explaining what HOMER and AME each do, how HOMER-generated target.fa and background.fa are reused by AME, how ASPEN parallelizes AME for speed, and how to interpret knownResults.txt and ame_results.txt.
  • Add high-level motif interpretation guidance to the overview page.
  • Add a development-version changelog entry for this user-facing documentation update.

Issues

Fixes #129

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • Update docs if there are any API changes.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

- [ ] Test run completes successfully on biowulf.

Generated using AI

Explain where motif enrichment outputs live, how HOMER and AME are run together, and how junior users should interpret the key result files.

_commit message is ai-generated_
@github-actions github-actions Bot added the ASPEN RepoName label Sep 24, 2026
kopardev and others added 2 commits September 24, 2026 14:38
Add the development-version changelog entry for the motif enrichment documentation work in PR #146.

_commit message is ai-generated_
@kopardev
kopardev merged commit 60dc35d into main Sep 25, 2026
5 checks passed
@kopardev
kopardev deleted the issue_129 branch September 25, 2026 17:59
@kopardev kopardev self-assigned this Sep 25, 2026
@kopardev kopardev added this to the 2026-09 milestone Sep 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ASPEN RepoName

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs for interpreting motif enrichment analysis results

1 participant