Restructure README and add Getting Started vignette #521
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sbfnk
previously approved these changes
Nov 28, 2023
This was referenced Nov 28, 2023
seabbs
requested changes
Nov 28, 2023
There was a problem hiding this comment.
This is really nice and a solid improvement. As @sbfnk suggests I would go with ordering the intro using the estimate_ functions vs the current approach. We also need to check CRAN policy to see what the new/views are on relative links. Finding a CRAN package that has them would also be good enough evidence for me.
Note: Either this PR or #504 are going to have some major merge issues. I suggest getting in quick.
jamesmbaazam
force-pushed
the
split-readme-to-vignette
branch
2 times, most recently
from
f9d921b to
20e8593
Compare
|
Where are we on this? |
jamesmbaazam
force-pushed
the
split-readme-to-vignette
branch
from
fdcaded to
3ba2d1f
Compare
I just rebased again. We can merge if it looks good. |
sbfnk
approved these changes
Jan 9, 2024
|
@seabbs I think this is ready to be merged. |
seabbs
approved these changes
Jan 9, 2024
sbfnk
pushed a commit
that referenced
this pull request
May 3, 2024
* Restructure README * Add Getting Started Vignette * Automatic readme update * Precompile Getting Started vignette * Fix partial matching * Use relative links * Restructure models section * Wrap package name in braces * Automatic readme update * Format package name --------- Co-authored-by: GitHub Action <[email protected]>
sbfnk
pushed a commit
that referenced
this pull request
May 3, 2024
* Restructure README * Add Getting Started Vignette * Automatic readme update * Precompile Getting Started vignette * Fix partial matching * Use relative links * Restructure models section * Wrap package name in braces * Automatic readme update * Format package name --------- Co-authored-by: GitHub Action <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #482 by moving The Quick Start section of the README to a Getting Started vignette ("EpiNow2.Rmd") and rewording sections of the new README and vignettes for flow and clarity.
Treat this PR as a complete rewrite of the README especially and suggest ways to improve current change.