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

Adds pipeline flow diagram to README #12

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Adds pipeline flow diagram to README #12

merged 1 commit into from
Jun 25, 2024

Conversation

BWMac
Copy link
Contributor

@BWMac BWMac commented Jun 25, 2024

This PR adds a mermaid diagram to the README file showing the flow of the nf-dcqc workflow.

@BWMac BWMac marked this pull request as ready for review June 25, 2024 20:14
@BWMac BWMac requested a review from a team as a code owner June 25, 2024 20:14
@github-actions GitHub Actions
Copy link

nf-core lint overall result: Failed ❌

Posted for pipeline commit 517dc92

+| ✅ 127 tests passed       |+
#| ❔  12 tests were ignored |#
!| ❗  20 tests had warnings |!
-| ❌  15 tests failed       |-

❌ Test failures:

  • files_exist - File must be removed: lib/NfcoreTemplate.groovy
  • files_exist - File must be removed: lib/Utils.groovy
  • files_exist - File must be removed: lib/WorkflowMain.groovy
  • nextflow_config - Config variable not found: params.validationShowHiddenParams
  • nextflow_config - Config variable not found: params.validationSchemaIgnoreParams
  • nextflow_config - Config default value incorrect: params.tracedir is set as ${params.outdir}/pipeline_info in nextflow_schema.json but is results/pipeline_info in nextflow.config.
  • files_unchanged - .github/CONTRIBUTING.md does not match the template
  • files_unchanged - .github/ISSUE_TEMPLATE/bug_report.yml does not match the template
  • files_unchanged - .github/PULL_REQUEST_TEMPLATE.md does not match the template
  • files_unchanged - .github/workflows/branch.yml does not match the template
  • files_unchanged - .github/workflows/linting_comment.yml does not match the template
  • files_unchanged - .github/workflows/linting.yml does not match the template
  • files_unchanged - assets/email_template.html does not match the template
  • schema_params - Param schema_ignore_params from nextflow config not found in nextflow_schema.json
  • multiqc_config - assets/multiqc_config.yml not found.

❗ Test warnings:

  • files_exist - File not found: assets/multiqc_config.yml
  • nextflow_config - Config manifest.version should end in dev: 0.1
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Write a 1-2 sentence summary of what data the pipeline is for and what it does
  • pipeline_todos - TODO string in README.md: Add full-sized test dataset and amend the paragraph below if applicable
  • pipeline_todos - TODO string in README.md: Fill in short bullet-pointed list of the default steps in the pipeline
  • pipeline_todos - TODO string in README.md: Update the example "typical command" below used to run the pipeline
  • pipeline_todos - TODO string in README.md: If applicable, make list of people who have also contributed
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in WorkflowMain.groovy: Add Zenodo DOI for pipeline after first release
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • pipeline_todos - TODO string in output.md: Write this documentation describing your workflow's output
  • pipeline_name_conventions - Naming does not adhere to nf-core conventions: Contains non alphanumeric characters
  • schema_lint - Schema $id should be https://raw.githubusercontent.com/sage-bionetworks-workflows/nf-dcqc/master/nextflow_schema.json
    Found https://raw.githubusercontent.com/sage/dcqc/master/nextflow_schema.json
  • system_exit - System.exit in WorkflowMain.groovy: System.exit(1) [line 85]
  • system_exit - System.exit in WorkflowDcqc.groovy: // System.exit(1) [line 18]
  • system_exit - System.exit in WorkflowDcqc.groovy: System.exit(1) [line 74]
  • nfcore_yml - nf-core version not set in .nf-core.yml

❔ Tests ignored:

  • files_exist - File is ignored: CODE_OF_CONDUCT.md
  • files_exist - File is ignored: assets/nf-core-dcqc_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-dcqc_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-dcqc_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File does not exist: CODE_OF_CONDUCT.md
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/config.yml
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/nf-dcqc/nf-dcqc/.github/workflows/awstest.yml

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-06-25 20:15:05

jaymedina
jaymedina approved these changes Jun 25, 2024
View reviewed changes
Copy link

@jaymedina jaymedina left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice! I compared this diagram against the dcqc workflow and corresponding subworkflows. The logic checks out and illustrates it well.

@BWMac BWMac merged commit eb3b8b2 into main Jun 25, 2024
4 of 7 checks passed
@BWMac BWMac deleted the bwmac/dcqc_flowchart branch June 25, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jaymedina jaymedina jaymedina approved these changes

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
@BWMac @jaymedina