Issue 12 add videos to readme #84
Merged
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
matt-dray
approved these changes
Aug 9, 2024
There was a problem hiding this comment.
Can confirm that the Rmd knits correctly. Links all appear to work, including the videos.
Approving, but I've added a few minor points as suggestions that you can batch-commit if you please; only one of them actually needs changing (an 'its' typo).
Might be possible to retain the Rmd only and have a GitHub Action to render it, rather than have to remember to re-knit to md after changes.
|
|
||
| You can install the current version of {NHSRwaitinglist} from GitHub with: | ||
|
|
||
| ```r |
There was a problem hiding this comment.
Suggested change
| ```r | |
| ```{r} |
README.Rmd
Outdated
| ```r | ||
| # install.packages("remotes") | ||
| remotes::install_github("nhs-r-community/NHSRwaitinglist", build_vignettes = TRUE) | ||
|
|
There was a problem hiding this comment.
Looks like pedantry, but I couldn't remember if blank lines in chunks end up being empty in the rendered version.
Suggested change
README.Rmd
Outdated
|
|
||
| ## Installation | ||
|
|
||
| You can install the current version of {NHSRwaitinglist} from GitHub with: |
There was a problem hiding this comment.
Could add a reference here to needing a GitHub PAT (e.g. {usethis} guide or Happy Git With R).
README.Rmd
Outdated
| 1. The [example walkthrough](https://nhs-r-community.github.io/NHSRwaitinglist/articles/example_walkthrough.html) vignette takes a step-by-step walk through the white paper, using the six core functions in this package. | ||
| 2. The [three example waiting lists](https://nhs-r-community.github.io/NHSRwaitinglist/articles/three_example_waiting_lists.html) vignette simulates three closely related waiting lists, and uses package functions to explore some of their characteristics. | ||
|
|
||
| At it's most basic, the package can be used to simulate a waiting list (a dataframe of waiting list addition dates and removal dates), and then compute some important statistics. Of course, if you already have waiting list data ready to analyse, you can skip the simulation step... |
There was a problem hiding this comment.
Suggested change
| At it's most basic, the package can be used to simulate a waiting list (a dataframe of waiting list addition dates and removal dates), and then compute some important statistics. Of course, if you already have waiting list data ready to analyse, you can skip the simulation step... | |
| At its most basic, the package can be used to simulate a waiting list (a dataframe of waiting list addition dates and removal dates), and then compute some important statistics. Of course, if you already have waiting list data ready to analyse, you can skip the simulation step in the code below. |
README.Rmd
Outdated
|
|
||
| # review the waiting list statistics | ||
| knitr::kable(overall_stats) | ||
|
|
README.Rmd
Outdated
| This project is released with a Contributor [Code of Conduct](./CODE_OF_CONDUCT.md). | ||
| By contributing to this project, you agree to abide by its terms. | ||
|
|
||
| The simplest way to contribute is to raise an issue detailing the feature or functionality you would like to see added, or any unexpected behaviour or bugs you have experienced. |
There was a problem hiding this comment.
Suggested change
| The simplest way to contribute is to raise an issue detailing the feature or functionality you would like to see added, or any unexpected behaviour or bugs you have experienced. | |
| The simplest way to contribute is to [raise an issue](https://github.com/nhs-r-community/NHSRwaitinglist/issues) detailing the feature or functionality you would like to see added, or any unexpected behaviour or bugs you have experienced. |
|
Many thanks @matt-dray for the great feedback! All incorporated, thank you. |
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.
closes #12
closes #59
Adds video links with thumbnails to the README (closing issue #12)
Adds basic use example to the README (closing issue #59)
Also changes the README to use R markdown to enable the example, and fix some formatting issues