-
Notifications
You must be signed in to change notification settings - Fork 8
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
Address Guidehouse feedback on landing page #450
Conversation
b75387d
to
de293f0
Compare
de293f0
to
d3827a3
Compare
Rebased & force-pushed to resolve DESCRIPTION + NEWS.md conflicts, plus improved a little wording in NEWS.md. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Suggestions are optional.
vignettes/epiprocess.Rmd
Outdated
This package introduces a common data structure for epidemiological data sets | ||
measured over space and time, and offers associated utilities to perform basic | ||
signal processing tasks. | ||
The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package provides |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: give broad intro before detailed list
The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package provides | |
The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package introduces a common data structure for epidemiological data sets | |
measured over space and time, and offers associated utilities to perform basic | |
signal processing tasks. | |
The package provides the following tools: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That intro intro's not accurate, I've taken a shot at an accurate one.
Checklist
Please:
PR).
brookslogan, nmdefries.
DESCRIPTION
. Always incrementthe 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).
(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).
process.
Change explanations for reviewer
This addresses some feedback we received from Guidehouse on the landing page; here are my notes:
There is some slightly-awkward link spam for
{epiprocess}
and{epipredict}
so that we retain braces around all package names; if we don't manually turn them into links, then they will automatically be turned into links anyway and have the braces dropped (and a slightly worse link for epipredict, probably because we list the repo URL before the github.io URL in the DESCRIPTION file).Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch