This repository has been archived by the owner on May 10, 2022. It is now read-only.
Add vignette #7
Merged
Add vignette #7
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
|
thanks for this @llrs having a look |
sckott
suggested changes
Oct 25, 2018
vignettes/jaod.Rmd
Outdated
| ) | ||
| ``` | ||
|
|
||
| Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The `html_vignette` output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The `html_vignette` format: |
There was a problem hiding this comment.
Can you remove this paragraph and bulleted list? We usually don't introduce the vignette format in vignettes.
There was a problem hiding this comment.
Oh, sorry I forgot to remove it
Suggested change
| Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The `html_vignette` output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The `html_vignette` format: |
|
Looks like you need to merge in changes from master before we can merge here |
Merge branch 'master' of https://github.com/ropensci/jaod # Conflicts: # DESCRIPTION
Codecov Report
@@ Coverage Diff @@
## master #7 +/- ##
=======================================
Coverage 94.82% 94.82%
=======================================
Files 6 6
Lines 58 58
=======================================
Hits 55 55
Misses 3 3Continue to review full report at Codecov.
|
sckott
approved these changes
Nov 7, 2018
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.
Suggestion cannot be applied right now. Please check back later.
Following the README.Rmd I created this PR to add a vignette (related to #2).
While creating the vignette I found is a lack of functions to use the data retrieved.
Also having a summary of the results obtained printed on the console when performing a query could come handy.