Data

Tools

Indexes

Applications

Experiments

Open Source Science

workbench-docs

The Carpentries Workbench Documentation

https://github.com/carpentries/workbench-docs

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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

The Carpentries Workbench Documentation

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 45
  • Releases: 0
Created 9 months ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

The Carpentries Workbench Documentation

This lesson gives a high-level overview of how you can use The Carpentries Workbench to build beautiful and accessible lessons from markdown or RMarkdown sources.

Setup the Workbench

To build this lesson locally, you should follow the setup instructions for the Workbench.

Quick Installation

In short, make sure you have R, Git, and Pandoc installed, then 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")) ```

Testing the Workbench Installation

Download this lesson from GitHub

There are two ways to download this lesson from GitHub:

  • via the command line: git clone https://github.com/carpentries/workbench-docs && cd workbench-docs
  • via R: r usethis::create_from_github("https://github.com/carpentries/workbench-docs/")

Build and Preview

Launch R in the workbench-docs folder and use this command to build and preview the lesson:

r library(sandpaper) sandpaper::serve()

This should open a web browser with the rendered local version of this lesson, built using the Workbench!

Owner

  • Name: The Carpentries
  • Login: carpentries
  • Kind: organization
  • Email: team@carpentries.org

The Carpentries teaches foundational coding, and data science skills to researchers worldwide.

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: 19
  • Push event: 18
  • Pull request event: 1
  • Create event: 2
Last Year
  • Issues event: 19
  • Push event: 18
  • Pull request event: 1
  • Create event: 2

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