📝 README: Use .Rmd and populate with basic information
#13
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
jibarozzo
approved these changes
Dec 10, 2024
|
Sounds good! |
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.
Here, I add a
README.Rmd, which is common practice in many other R packages: https://github.com/tidyverse/dplyr/blob/main/README.RmdThe benefit of this, is that the
.Rmdwill automatically render any code examples we provide, which can be helpful for users to see how things work (and can also serve as a very basic integration test)A drawback is that we need to remember to re-knit the
README.Rmdto ensure it stays up to date (this could also in theory be automated with a GH action, but I don't have the energy to do that right now 😊 )