Skip to content

docs: update BUSCO output docs after excluding complete directory#1075

Merged
dialvarezs merged 2 commits into
nf-core:devfrom
dialvarezs:chore/busco-docs-output
Jul 16, 2026
Merged

docs: update BUSCO output docs after excluding complete directory#1075
dialvarezs merged 2 commits into
nf-core:devfrom
dialvarezs:chore/busco-docs-output

Conversation

@dialvarezs

Copy link
Copy Markdown
Member

Follow-up to #1074.

#1074 changed the BUSCO publishDir pattern in conf/modules.config from *{.txt,.json,.log,-busco} to *{.txt,.json,.log}, so the per-bin [assembler]-[bin]/ complete directory is no longer published. docs/output.md still described those files.

This PR:

  • Removes the [assembler]-[bin]/ block from docs/output.md (prodigal_output/, logs/, run-[lineage]/full_table.tsv, missing_busco_list.tsv, busco_sequences/).
  • Removes the busco_clean=false note, since that subdirectory is no longer published regardless of the flag.
  • Adds a CHANGELOG entry.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If necessary, also make a PR on the nf-core/mag branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes.
  • Check for unexpected warnings in debug mode.
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

🤖 Generated with Claude Code

PR nf-core#1074 changed the BUSCO publishDir pattern in conf/modules.config from
"*{.txt,.json,.log,-busco}" to "*{.txt,.json,.log}", so the per-bin
[assembler]-[bin]/ complete directory (prodigal_output/, logs/,
run-[lineage]/full_table.tsv, missing_busco_list.tsv, busco_sequences/) is
no longer published. Remove it from docs/output.md, along with the now-moot
busco_clean=false note, since that subdirectory is no longer published at all.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dialvarezs

Copy link
Copy Markdown
Member Author

Thanks @FriederikeHanssen!

@dialvarezs
dialvarezs merged commit dfcb60d into nf-core:dev Jul 16, 2026
6 checks passed
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

Successfully merging this pull request may close these issues.

2 participants