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

minor readme changes #284

Merged
merged 1 commit into from
Jun 20, 2024
Merged

minor readme changes #284

merged 1 commit into from
Jun 20, 2024

Conversation

dsweber2
Copy link
Contributor

Checklist

Please:

  • Make sure this PR is against "dev", not "main" (unless this is a release
    PR).
  • Request a review from one of the current epidatr main reviewers:
    brookslogan, dshemetov, nmdefries, dsweber2.
  • Makes sure to bump the version number in DESCRIPTION. Always increment
    the patch version number (the third number), unless you are making a
    release PR from dev to main, in which case increment the minor version
    number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    1.7.2, then write your changes under the 1.8 heading).

Change explanations for reviewer

sorry for the spam. First this, then the merge to main. should be submitting to CRAN after that though

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

  • Resolves #{issue number}

@@ -82,7 +82,7 @@ pak::pkg_install("cmu-delphi/epidatr@dev")
```

Our CRAN listing is
[here](https://cran.r-project.org/web/packages/epidatr/index.html).
[here](https://CRAN.R-project.org/package=epidatr/index.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Looks like this link redirects to the old URL. Is there a benefit to doing it this way?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

cran prefers this format, for whatever reason

Copy link
Contributor Author

Choose a reason for hiding this comment

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


Found the following (possibly) invalid URLs:
  URL: https://cran.r-project.org/web/packages/epidatr/index.html
    From: README.md
    Status: 200
    Message: OK
    CRAN URL not in canonical form
  URL: https://www.cdc.gov/datastatistics/index.html
    From: README.md
    Status: 404
    Message: Not Found
  The canonical URL of the CRAN page for a package is 
    https://CRAN.R-project.org/package=pkgname

Copy link
Contributor Author

Choose a reason for hiding this comment

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

from the win_builder check

Copy link
Contributor

Choose a reason for hiding this comment

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

Huh, I guess it's kinda neat that it checks URLs for you.

Copy link
Contributor

@dshemetov dshemetov Jun 20, 2024

Choose a reason for hiding this comment

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

This page says the canonical URL is

https://cran.r-project.org/package=package-name

not sure if win_builder will complain aobut that index.html in there

Copy link
Contributor Author

@dsweber2 dsweber2 Jun 20, 2024

Choose a reason for hiding this comment

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

urlchecker::url_check() was satisfied, which gives a more obscure version of the win_builder result, so I think we're good. Thanks for the catch though

@dsweber2 dsweber2 merged commit 04da7e0 into dev Jun 20, 2024
8 checks passed
@dsweber2 dsweber2 deleted the readmeTweak branch June 20, 2024 18:27
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