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

Issue273/README fixes and HTML stats #283

Merged
merged 19 commits into from
Oct 11, 2023
Merged

Conversation

mattloose
Copy link
Contributor

This pull request addresses a number of issues (see commits).

All images are linked to the raw github urls to allow docs to propagate correctly.

@mattloose
Copy link
Contributor Author

I also note I cannot spell the word brief.

README.md Outdated Show resolved Hide resolved
@Adoni5 Adoni5 changed the title Feature/readme image update Issue273/README fixes and HTML stats Oct 11, 2023
@Adoni5
Copy link
Contributor

Adoni5 commented Oct 11, 2023

PR now covers two additions to readfish.

Closes #273

1. HTML flag on stats

ReadfishSummarise 0.2.5 and by extension readfish stats outputs a HTML table of the summary via the use of an OPT IN flag --html <FILENAME>. This was added so we can embed a more readable table to the README.md

2. README updates

  1. Readme images updated to Minknow 5.7.5
  2. Link to 5khz R10 NA12878 bulk file added
  3. Links to the image sin the main branch of ReadFish added
  4. Example analysis output from readfish stats using the --html flag added to the analysing test output section.

Copy link
Contributor

@Adoni5 Adoni5 left a comment

Choose a reason for hiding this comment

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

Have been through the README, looks good. Once merged we should move refactor to main and have magic working images again.

@mattloose mattloose merged commit f058cdd into refactor Oct 11, 2023
9 checks passed
@mattloose mattloose deleted the feature/readme_image_update branch October 11, 2023 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants