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

Improve the pipeline workflow graphic/map #10

Merged
merged 3 commits into from
Jul 24, 2024
Merged

Conversation

U13bs1125
Copy link
Contributor

followed the guidlines from nf-core site: https://nf-co.re/docs/guidelines/graphic_design

PR checklist

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

Copy link
Collaborator

@charles-plessy charles-plessy left a comment

Choose a reason for hiding this comment

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

Nice work, and it addresses the comments in PR #9 !

@charles-plessy charles-plessy merged commit cd92f37 into nf-core:dev Jul 24, 2024
4 checks passed
Copy link
Contributor

Choose a reason for hiding this comment

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

nice improvement. More smaller comments if I may:

  • the logo is off: the "parigenomealign" is squeezed and the apple is too close to nf-core (plus if you keep the slash from the original logo, it makes it more coherent with other nf-core logos, but this is not that important, just gives a nicer consistency over all)
  • you explain the black and the blue, but not the green line.
  • could you use connected dots for shared steps in the top left (see https://raw.githubusercontent.com/nf-core/taxprofiler/1.1.8//docs/images/taxprofiler_tube.png as an example). Also I would differentiate between input dots, output dots and processing dots (was looking for a label for the first dots 🙂)
  • I think you can simplify the labels a bit so you don't have to repeat yourself so often especially for the results. one idea: drop the "alignment(s)" and write it as a section label to the right. group the different alignments with their corresponding dotpots, for example with using a different color for each type (again take taxprofiler's tubemap as an example)

Copy link
Contributor

Choose a reason for hiding this comment

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

oh and one more thing: if you add the version number of the release to the map (usually next to the logo), it becomes easier to differentiate if the pipeline's functionality grows

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.

3 participants