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.

Sign up for GitHub

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

Jump to bottom

Better docs for taxpasta related flags #573

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Better docs for taxpasta related flags #573

merged 1 commit into from
Jan 30, 2025

Conversation

jfy133
Copy link
Member

@jfy133 jfy133 commented Jan 30, 2025

closes #572

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 you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/taxprofiler branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • 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).

@jfy133 jfy133 marked this pull request as ready for review January 30, 2025 09:17
@jfy133 jfy133 requested a review from sofstam January 30, 2025 09:17
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 30, 2025 •
edited
Loading

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 22380d6

+| ✅ 278 tests passed       |+
!| ❗  18 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • local_component_structure - kraken2_standard_report.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - krona_cleanup.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - visualization_krona.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_complexityfiltering.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - standardisation_profiles.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - nonpareil.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_adapterremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_fastp.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_filtering.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - profiling.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_adapterremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

✅ Tests passed:

Run details

  • nf-core/tools version 3.2.0
  • Run at 2025-01-30 09:19:39

@jfy133 jfy133 requested a review from alexhbnr January 30, 2025 09:27
@jfy133 jfy133 merged commit 7415c81 into dev Jan 30, 2025
26 checks passed
@jfy133 jfy133 deleted the better-docs branch January 30, 2025 13:38
jfy133 added a commit that referenced this pull request Feb 5, 2025
@jfy133
Merge pull request #575 from nf-core/changelog-for-docschagnes
c3a6b58 
Changelog for for #573
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexhbnr alexhbnr alexhbnr approved these changes

@sofstam sofstam Awaiting requested review from sofstam

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jfy133 @alexhbnr