Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary

Keywords

carpentries-incubator english lesson pre-alpha reproducibility reproducible-research
Last synced: 6 months ago · JSON representation ·

Repository

Lesson material for Reproducible research through reusable code workshop

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 2
  • Open Issues: 14
  • Releases: 0
Topics
carpentries-incubator english lesson pre-alpha reproducibility reproducible-research
Created about 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

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. 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 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)

Owner

  • Name: carpentries-incubator
  • Login: carpentries-incubator
  • Kind: organization

Citation (CITATION.cff) 

# This template CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to replace its contents
# with information about your lesson.
# Remember to update this file periodically, 
# ensuring that the author list and other fields remain accurate.

cff-version: 1.2.0
title: FIXME
message: >-
  Please cite this lesson using the information in this file
  when you refer to it in publications, and/or if you
  re-use, adapt, or expand on the content in your own
  training material.
type: dataset
authors:
  - given-names: FIXME
    family-names: FIXME
abstract: >-
  FIXME Replace this with a short abstract describing the
  lesson, e.g. its target audience and main intended
  learning objectives.
license: CC-BY-4.0

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 15
  • Pull request event: 1
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 15
  • Pull request event: 1
  • Create event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 39
  • Total Committers: 2
  • Avg Commits per committer: 19.5
  • Development Distribution Score (DDS): 0.436
Past Year
  • Commits: 39
  • Committers: 2
  • Avg Commits per committer: 19.5
  • Development Distribution Score (DDS): 0.436
Top Committers
Name Email Commits
eduardklap e****k@g****m 22
Sven van der Burg s****g@e****l 17
Committer Domains (Top 20 + Academic)
esciencecenter.nl: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 13
  • Total pull requests: 19
  • Average time to close issues: 7 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.08
  • Average comments per pull request: 1.21
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 13
  • Pull requests: 19
  • Average time to close issues: 7 days
  • Average time to close pull requests: 1 day
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.08
  • Average comments per pull request: 1.21
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • svenvanderburg (5)
Pull Request Authors
  • svenvanderburg (9)
  • eduardklap (8)
  • carpentries-bot (1)
Top Labels
Issue Labels
Pull Request Labels
type: template and tools (1)

Dependencies

.github/workflows/pr-close-signal.yaml actions
  • actions/upload-artifact v4 composite
.github/workflows/pr-comment.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
  • carpentries/actions/download-workflow-artifact main composite
.github/workflows/pr-post-remove-branch.yaml actions
  • carpentries/actions/download-workflow-artifact main composite
  • carpentries/actions/remove-branch main composite
.github/workflows/pr-preflight.yaml actions
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
.github/workflows/pr-receive.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/sandpaper-main.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-cache.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-lockfile main composite
  • carpentries/create-pull-request main composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-workflows.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-workflows main composite
  • carpentries/create-pull-request main composite