- Improve readme and add getting started vignette (#44, @sharlagelfand). #44
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
Codecov Report
@@ Coverage Diff @@
## master #44 +/- ##
=======================================
Coverage 11.11% 11.11%
=======================================
Files 4 4
Lines 36 36
=======================================
Hits 4 4
Misses 32 32
Continue to review full report at Codecov.
|
krlmlr
requested changes
Jan 31, 2020
Co-Authored-By: Kirill Müller <krlmlr@users.noreply.github.com>
…into improve-readme
|
thanks, fixed the illustration size + ref! |
krlmlr
changed the title
|
Thanks! The docs are in much better shape now! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Improve README by adding:
Also added a "Getting Started" vignette which contains most of the same information as the README, but also further details on using here (and why we want to) in an Rmd in a subdirectory.
I assume you'll want to re-render the README so that it doesn't contain the file path to my tidy dev day folder. I'm a little fuzzy on where things (especially the pkgdown docs) might be off since @krlmlr has been making changes to the package while i've been working on it, but happy to work through it.
Closes #42