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

Remove double image in the README #72

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Remove double image in the README #72

wants to merge 1 commit into from

Conversation

SPPearce
Copy link
Contributor

@SPPearce SPPearce commented Sep 5, 2024

No description provided.

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 5, 2024 •
edited
Loading

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 56a0010

+| ✅ 170 tests passed       |+
#| ❔   8 tests were ignored |#
!| ❗   1 tests had warnings |!

❗ Test warnings:

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-09-05 06:00:51

@SPPearce SPPearce mentioned this pull request Sep 5, 2024
Merged
5 tasks
znorgaard
znorgaard reviewed Sep 5, 2024
View reviewed changes
Copy link
Collaborator

@znorgaard znorgaard left a comment

Choose a reason for hiding this comment

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

I believe the two images are intentional and provide slightly different information.

README.md
@@ -25,9 +25,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool

On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources. The results obtained from the full-sized test can be viewed on the [nf-core website](https://nf-co.re/fastquorum/results).

| Tools | Description |
| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| <p align="center"><img title="Fastquorum Workflow (Tools)" src="docs/images/fastquorum_subway.png" width=100%></p> | <p align="center"><img title="Fastquorum Workflow (Description)" src="docs/images/fastquorum_subway.desc.png" width=100%></p> |
Copy link
Collaborator

Choose a reason for hiding this comment

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

These are actually different images. The left hand side, "Tools", fastquorum_subway.png lists the tool names and the right hand side, "Description", fastquorum_subway.desc.png describes what those tools do at each step.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Mmm, I don't see the reason to have both to be honest.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It feels a little redundant because most of the tools have descriptive names, but I can appreciate the intention to clarify what each is doing. We can discuss further when Nils is back, but I don't see this as a needed change for the release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fine, we can release without changing this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@znorgaard znorgaard znorgaard left review comments

At least 1 approving review is required to merge this pull request.

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
@SPPearce @znorgaard