https://github.com/carpentries-incubator/reproducible-research-through-reusable-code-in-1-day
Lesson material for Reproducible research through reusable code workshop
https://github.com/carpentries-incubator/reproducible-research-through-reusable-code-in-1-day
carpentries-incubator english lesson pre-alpha reproducibility reproducible-research
Last synced: about 1 month ago
JSON representation
Lesson material for Reproducible research through reusable code workshop
- Host: GitHub
- URL: https://github.com/carpentries-incubator/reproducible-research-through-reusable-code-in-1-day
- Owner: carpentries-incubator
- License: other
- Created: 2024-11-27T12:23:27.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-02T00:51:22.000Z (about 1 month ago)
- Last Synced: 2025-09-02T02:38:52.141Z (about 1 month ago)
- Topics: carpentries-incubator, english, lesson, pre-alpha, reproducibility, reproducible-research
- Homepage: https://carpentries-incubator.github.io/reproducible-research-through-reusable-code-in-1-day/
- Size: 10.7 MB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Reproducible research through reusable code
This workshop teaches you the skills to make your code reusable by others.
In one day you will share your coding project on GitHub and work on
the minimal requirements needed for others to run your code.
At the end of the day we will do a short reusability check of each other's repository.
## Target audience
This workshop is aimed at researchers who want to make their code reusable.
You are able to write basic code in a programming language like R or Python.
This can be a few simple lines of code or a larger piece of software.
Participants must bring their own coding project to the workshop. This can range from a few small scripts to an extensive piece of software.
If you are already familiar with using version control and GitHub,
documenting dependencies of your project, basic software documentation,
and basic coding conventions, and the basics of modular coding than this course is probably to introductory for you.
## Setup the Workshop Website locally
To build this lesson locally, you should follow the [setup instructions for the
workbench](https://carpentries.github.io/sandpaper-docs/#overview). In short,
make sure you have R, Git, and Pandoc installed, open R and use the following
commands to install/update the packages needed for the infrastructure:
```r
# register the repositories for The Carpentries and CRAN
options(repos = c(
carpentries = "https://carpentries.r-universe.dev/",
CRAN = "https://cran.rstudio.com/"
))
# Install the template packages to your R library
install.packages(c("sandpaper", "varnish", "pegboard", "tinkr"))
```
## Rendering the website locally
See the [Carpentries Workbench usage instructions](https://carpentries.github.io/workbench/#usage) on how to render the website locally.
## Maintainer(s)
Current maintainers of this lesson are
* Sven van der Burg (svenvanderburg@gmail.com)
* Eduard Klapwijk (et.klapwijk@gmail.com)