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

Update nextflow-workflow.rst #238

Merged
merged 8 commits into from
Feb 16, 2022
Merged

Update nextflow-workflow.rst #238

merged 8 commits into from
Feb 16, 2022

Conversation

samche42
Copy link
Collaborator

@samche42 samche42 commented Feb 15, 2022

Quick start instructions added :) Please confirm that format is acceptable! It also won't let me upload the images so I've sent those to you (Evan) via Slack. let me know if they need to be sent to someone else for upload.

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/autometa branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint .).
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • 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).

Quick start instructions added :) Please confirm that format is acceptable! It also won't let me upload the images so I've sent those to you (Evan) via Slack. let me know if they need to be sent to someone else for upload.
@github-actions
Copy link

github-actions bot commented Feb 15, 2022

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit cafb114

+| ✅  62 tests passed       |+
#| ❔  34 tests were ignored |#
!| ❗   9 tests had warnings |!

❗ Test warnings:

  • readme - README did not have a Nextflow minimum version badge.
  • readme - README did not have a Nextflow minimum version mentioned in Quick Start section.
  • schema_lint - Schema $id should be https://raw.githubusercontent.com/autometa/master/nextflow_schema.json
    Found https://raw.githubusercontent.com/autometa/main/nextflow_schema.json
  • schema_description - No description provided in schema for parameter: plaintext_email
  • schema_description - No description provided in schema for parameter: custom_config_version
  • schema_description - No description provided in schema for parameter: custom_config_base
  • schema_description - No description provided in schema for parameter: hostnames
  • schema_description - No description provided in schema for parameter: show_hidden_params
  • schema_description - No description provided in schema for parameter: singularity_pull_docker_container

❔ Tests ignored:

  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/feature_request.yml
  • files_exist - File is ignored: .github/workflows/branch.yml
  • files_exist - File is ignored: .github/workflows/ci.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: assets/nf-core-autometa_logo_light.png
  • files_exist - File is ignored: docs/usage.md
  • files_exist - File is ignored: docs/output.md
  • files_exist - File is ignored: docs/images/nf-core-autometa_logo.png
  • files_exist - File is ignored: docs/images/nf-core-autometa_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-autometa_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/bug_report.md
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/feature_request.md
  • nextflow_config - nextflow_config
  • files_unchanged - File ignored due to lint config: LICENSE or LICENSE.md or LICENCE or LICENCE.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/feature_request.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File does not exist: .github/workflows/branch.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting_comment.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File ignored due to lint config: assets/email_template.html
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File does not exist: assets/nf-core-autometa_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-autometa_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-autometa_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • files_unchanged - File ignored due to lint config: lib/NfcoreTemplate.groovy
  • files_unchanged - File ignored due to lint config: .gitignore or foo
  • actions_ci - '.github/workflows/ci.yml' not found
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/Autometa/Autometa/.github/workflows/awstest.yml
  • template_strings - template_strings

✅ Tests passed:

Run details

  • nf-core/tools version 2.2
  • Run at 2022-02-16 15:53:36

@github-actions
Copy link

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit d1d941e

+| ✅  62 tests passed       |+
#| ❔  34 tests were ignored |#
!| ❗   9 tests had warnings |!

❗ Test warnings:

  • readme - README did not have a Nextflow minimum version badge.
  • readme - README did not have a Nextflow minimum version mentioned in Quick Start section.
  • schema_lint - Schema $id should be https://raw.githubusercontent.com/autometa/master/nextflow_schema.json
    Found https://raw.githubusercontent.com/autometa/main/nextflow_schema.json
  • schema_description - No description provided in schema for parameter: plaintext_email
  • schema_description - No description provided in schema for parameter: custom_config_version
  • schema_description - No description provided in schema for parameter: custom_config_base
  • schema_description - No description provided in schema for parameter: hostnames
  • schema_description - No description provided in schema for parameter: show_hidden_params
  • schema_description - No description provided in schema for parameter: singularity_pull_docker_container

❔ Tests ignored:

  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/feature_request.yml
  • files_exist - File is ignored: .github/workflows/branch.yml
  • files_exist - File is ignored: .github/workflows/ci.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: assets/nf-core-autometa_logo_light.png
  • files_exist - File is ignored: docs/usage.md
  • files_exist - File is ignored: docs/output.md
  • files_exist - File is ignored: docs/images/nf-core-autometa_logo.png
  • files_exist - File is ignored: docs/images/nf-core-autometa_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-autometa_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/bug_report.md
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/feature_request.md
  • nextflow_config - nextflow_config
  • files_unchanged - File ignored due to lint config: LICENSE or LICENSE.md or LICENCE or LICENCE.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/feature_request.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File does not exist: .github/workflows/branch.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting_comment.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File ignored due to lint config: assets/email_template.html
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File does not exist: assets/nf-core-autometa_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-autometa_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-autometa_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • files_unchanged - File ignored due to lint config: lib/NfcoreTemplate.groovy
  • files_unchanged - File ignored due to lint config: .gitignore or foo
  • actions_ci - '.github/workflows/ci.yml' not found
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/Autometa/Autometa/.github/workflows/awstest.yml
  • template_strings - template_strings

✅ Tests passed:

Run details

  • nf-core/tools version 2.2
  • Run at 2022-02-15 14:28:41

Copy link
Collaborator

@evanroyrees evanroyrees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a few formatting errors, but I think this will really make running autometa using nextflow much more approachable!

To display the screenshots you would like to include, you will need to commit these to your pull request as well. Please place these in the same folder as other images hosted for the documentation ($HOME/Autometa/docs/img) and link to them appropriately.

docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
docs/source/nextflow-workflow.rst Outdated Show resolved Hide resolved
samche42 and others added 2 commits February 15, 2022 10:58
Co-authored-by: Evan Rees <25933122+WiscEvan@users.noreply.github.com>
Co-authored-by: Evan Rees <25933122+WiscEvan@users.noreply.github.com>
samche42 and others added 3 commits February 15, 2022 13:36
- Fix broken cross-ref
- Fix formatting errors
- Fix typos
- Add unordered list of KwanLab/Autometa nf-core parameter settings
- Add/Move some sections into note blocks
- Add custom anchors for each KwanLab/Autometa nf-core parameter setting
- 📝 Add headers for running Autometa section of quickstart
- 📝🔥 Fix errors in formatting for code blocks and incorrect indents
- Add N50 for example assembly in Binning parameters section
- 📝🐛 fix ref where a colon was missing causing a broken cross reference.
- 📝🔥 Remove incorrect indentation causing incorrect bold in Additional Autometa parameters section
@evanroyrees evanroyrees merged commit 13591f0 into KwanLab:main Feb 16, 2022
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.

None yet

2 participants