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 #464 and #177: Bring README into line with epinowcast standards #472

Merged
merged 4 commits into from
Nov 25, 2024

Conversation

seabbs
Copy link
Contributor

@seabbs seabbs commented Nov 24, 2024

… community code

Description

This PR closes #464 and #177. It fixes the badges in line with epinowcast standards, adds back in README text again in line with epinowcast practice, adds a epidist DOI where needed (this required making a pre-release to initialise zenodo.

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.

@seabbs
Copy link
Contributor Author

seabbs commented Nov 24, 2024

Note mac CI is failing everywhere in R world due to an issue installing R.

@seabbs seabbs changed the title Issue #464 and #177 Issue #464 and #177: Bring README into line with epinowcast standards Nov 24, 2024
@seabbs
Copy link
Contributor Author

seabbs commented Nov 24, 2024

CI failure is ecosystem-wide R failing to install on mac

@seabbs seabbs requested a review from athowes November 24, 2024 21:26
@seabbs
Copy link
Contributor Author

seabbs commented Nov 25, 2024

not all the links work with epinowcast/epidist.

README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
@seabbs
Copy link
Contributor Author

seabbs commented Nov 25, 2024

I've made all the links explicit for safety and caught the out of date cmdstanr install instructions

Copy link
Collaborator

@athowes athowes left a comment

Choose a reason for hiding this comment

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

Thanks, good to have a way to install the package off GitHub. About the R universe, is it that we follow some process to update the r-universe version each time we would like to? Is this each release? Is this automated somehow e.g. if we do x.y.z and bump e.g. y? Does the R universe version solve our "big history" issue?

@seabbs seabbs requested a review from athowes November 25, 2024 11:09
@seabbs
Copy link
Contributor Author

seabbs commented Nov 25, 2024

  1. Its automated by github release
  2. It doesn't work at the moment due to the big install size

@athowes
Copy link
Collaborator

athowes commented Nov 25, 2024

It doesn't work at the moment due to the big install size

It doesn't work as in the R universe install link/code doesn't work? If it doesn't work, I guess we shouldn't be closing that issue?

@seabbs
Copy link
Contributor Author

seabbs commented Nov 25, 2024

it doesn't work due to the git size which we can separately resolve

Copy link
Collaborator

@athowes athowes left a comment

Choose a reason for hiding this comment

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

Suggest may want to clarify the extent to which the R universe install currently works. Don't want users to be frustrated that they try doing what is suggested and it doesn't work, so possibly this could be in the text. Also probably look to make it work sooner rather than later if it doesn't.

@seabbs seabbs merged commit b3d1905 into main Nov 25, 2024
8 of 9 checks passed
@seabbs seabbs deleted the issue464 branch November 25, 2024 11:57
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.

Use the same README badge layout as primarycensored
2 participants