Writing-packages #2927
Open
Writing-packages #2927
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
✅ Deploy Preview for the-turing-way ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
👋 Can you please confirm that I’m looking at the right place? https://deploy-preview-2927--the-turing-way.netlify.app/reproducible-research/code-reuse/code-reuse-packages.html 🙈 EDIT: Ah, so it is. 😄 |
RaoOfPhysics
requested changes
Jan 5, 2023
There was a problem hiding this comment.
Nice work, @arronlacey! Have left some content edits and some style ones, for you to consider/implement. :)
| # Overview of writing packages | ||
|
|
||
| This section provides an overview of why software packages and libraries are useful for code reproducibility and why you might want to write your own packages. | ||
| Packages are written to a high standard of reproducible code (see the guidelines for [publishing an R package on CRAN](https://cran.r-project.org/web/packages/policies.html)), where recommendations such as those found in the {ref}`rr-code-reuse-details` and {ref}`rr-code-reuse-recommendations` sections are commonly employed to ensure reproducibility of the functionality of the package. |
There was a problem hiding this comment.
This sentence could be simplified, possibly split. It’s a tad unwieldy.
There was a problem hiding this comment.
Hopefully 2498f2b helps with this?
book/website/reproducible-research/code-reuse/code-reuse-packages.md
Outdated
Show resolved
Hide resolved
book/website/reproducible-research/code-reuse/code-reuse-packages.md
Outdated
Show resolved
Hide resolved
book/website/reproducible-research/code-reuse/code-reuse-packages.md
Outdated
Show resolved
Hide resolved
book/website/reproducible-research/code-reuse/code-reuse-packages.md
Outdated
Show resolved
Hide resolved
|
Thanks very much for looking at this @RaoOfPhysics - I'll take a look over the new few days. |
Co-authored-by: Achintya Rao <achintya@achintyarao.in>
…ges.md Co-authored-by: Achintya Rao <achintya@achintyarao.in>
…ges.md Co-authored-by: Achintya Rao <achintya@achintyarao.in>
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.
Summary
This sub-section aims to give an overview of reusing code by creating software packages. It should provide the reader the basic idea of what a package is, the motivation for writing one, some reccomendations and a very quick MWE.
What should a reviewer concentrate their feedback on?
Acknowledging contributors