Data

Tools

Indexes

Applications

Experiments

Open Source Science

sandpaper-docs

Documentation for The Carpentries Workbench

https://github.com/carpentries/sandpaper-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 (7.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Documentation for The Carpentries Workbench

Basic Info
Statistics
  • Stars: 7
  • Watchers: 5
  • Forks: 47
  • Open Issues: 22
  • Releases: 0
Created about 5 years 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 (our new and improved lesson infrastructure) to build beautiful and accessible lessons from markdown or RMarkdown sources.

If you want to try out this lesson, you can create a copy of it on the RStudio Cloud: https://rstudio.cloud/project/3507333

Setup the Workbench

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")) ```

Download this lesson from GitHub

There are two ways to download the lesson from github:

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

Build and Preview

Launch R in this folder and use this command to build and preview the lesson

r sandpaper::serve()

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) 

cff-version: 1.2.0
title: Introduction to The Carpentries Workbench
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. To cite the Workbench software itself,
  please refer to the websites for the individual
  components:
  https://carpentries.github.io/sandpaper/authors.html#citation,
  https://carpentries.github.io/pegboard/authors.html#citation,
  https://carpentries.github.io/varnish/authors.html#citation
type: dataset
authors:
  - given-names: Zhian
    family-names: Kamvar
    name-particle: N.
    orcid: 'https://orcid.org/0000-0003-1458-7108'
  - given-names: Toby
    family-names: Hodges
    email: tobyhodges@carpentries.org
    affiliation: The Carpentries
    orcid: 'https://orcid.org/0000-0003-1766-456X'
  - given-names: Erin
    family-names: Becker
    orcid: 'https://orcid.org/0000-0002-6832-0233'
  - orcid: 'https://orcid.org/0000-0002-7040-548X'
    given-names: Sarah
    family-names: Stevens
  - given-names: Michael
    family-names: Culshaw-Maurer
    orcid: 'https://orcid.org/0000-0003-2205-8679'
  - given-names: Maneesha
    family-names: Sane
  - given-names: Robert
    family-names: Davey
    orcid: 'https://orcid.org/0000-0002-5589-7754'
  - given-names: Amelia
    family-names: Bertozzi-Villa
  - given-names: Kaitlin
    family-names: Newson
    orcid: 'https://orcid.org/0000-0001-8739-5823'
  - given-names: Jennifer
    family-names: Stubbs
    orcid: 'https://orcid.org/0000-0002-6080-5703'
  - given-names: Belinda
    family-names: Weaver
  - given-names: François
    family-names: Michonneau
    orcid: 'https://orcid.org/0000-0002-9092-966X'
repository-code: 'https://github.com/carpentries/sandpaper-docs'
url: 'https://carpentries.github.io/sandpaper-docs/'
abstract: >-
  Documentation for The Carpentries Workbench, a set of
  tools that can be used to create accessible lesson
  websites.
keywords:
  - Carpentries
  - sandpaper
  - pegboard
  - varnish
  - R
  - pkgdown
license: CC-BY-4.0

GitHub Events

Total
  • Issues event: 19
  • Watch event: 1
  • Delete event: 38
  • Issue comment event: 48
  • Push event: 131
  • Pull request review comment event: 7
  • Pull request review event: 8
  • Pull request event: 42
  • Fork event: 5
  • Create event: 40
Last Year
  • Issues event: 19
  • Watch event: 1
  • Delete event: 38
  • Issue comment event: 48
  • Push event: 131
  • Pull request review comment event: 7
  • Pull request review event: 8
  • Pull request event: 42
  • Fork event: 5
  • Create event: 40

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 19
  • Total pull requests: 45
  • Average time to close issues: 6 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 14
  • Total pull request authors: 8
  • Average comments per issue: 0.84
  • Average comments per pull request: 0.98
  • Merged pull requests: 29
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 13
  • Pull requests: 24
  • Average time to close issues: 7 days
  • Average time to close pull requests: 3 days
  • Issue authors: 9
  • Pull request authors: 5
  • Average comments per issue: 1.08
  • Average comments per pull request: 0.71
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
  • gcapes (4)
  • ErinBecker (2)
  • tobyhodges (2)
  • theabro (1)
  • brownsarahm (1)
  • froggleston (1)
  • Goli-SF (1)
  • jesse-ross (1)
  • rgaiacs (1)
  • RicCampbell (1)
  • ross-spencer (1)
  • smangham (1)
  • zkamvar (1)
  • carpentries-bot (1)
Pull Request Authors
  • carpentries-bot (17)
  • tobyhodges (13)
  • ErinBecker (9)
  • froggleston (3)
  • github-actions[bot] (2)
  • zkamvar (2)
  • bertozzivill (1)
  • olexandr-konovalov (1)
Top Labels
Issue Labels
documentation (2) help wanted (1) macOS (1) SOLUTION (1) type: template and tools (1)
Pull Request Labels
type: package cache (13) type: template and tools (6) documentation (1)

Dependencies

.github/workflows/pr-close-signal.yaml actions
  • actions/upload-artifact v2 composite
.github/workflows/pr-comment.yaml actions
  • actions/checkout v3 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 v3 composite
  • actions/upload-artifact v2 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 v3 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 v3 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-lockfile main composite
  • peter-evans/create-pull-request v4.2.0 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-workflows.yaml actions
  • actions/checkout v3 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-workflows main composite
  • peter-evans/create-pull-request v4.2.0 composite