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

Issue #132: Updates to README #387

Merged
merged 11 commits into from
Oct 15, 2024
Merged

Issue #132: Updates to README #387

merged 11 commits into from
Oct 15, 2024

Conversation

athowes
Copy link
Collaborator

@athowes athowes commented Oct 14, 2024

Description

This is a draft PR to close #132.

It's quite self expanatory. The change that hasn't been made is some kind of diagram or figure.

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

LGTM

@athowes athowes marked this pull request as ready for review October 15, 2024 08:52
@athowes athowes merged commit 9cc8089 into main Oct 15, 2024
7 checks passed
@athowes athowes deleted the readme-links branch October 15, 2024 11:11
Comment on lines +39 to +44
To learn more about `epidist` we recommend reading the vignettes in this order:

* [Getting started with `epidist`](https://epidist.epinowcast.org/articles/epidist.html)
* [Using `epidist` to estimate delay between symptom onset and positive test for an Ebola outbreak in Sierra Leone](https://epidist.epinowcast.org/articles/ebola.html)
* [Approximate Bayesian inference in `epidist`](https://epidist.epinowcast.org/articles/approx-inference.html)

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry to comment though already merged. You could signpost in the vignettes using a format similar to that used in finalsize

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.

Updates to README
3 participants