looseleaf

Research compendium template for tracking, linking, and sharing data explorations

https://github.com/jsta/looseleaf

Science Score: 28.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
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    5 of 36 committers (13.9%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary

Keywords from Contributors

carpentries english lesson stable geospatial-data carpentries-incubator climate alpha helpwanted-list bioinformatics
Last synced: 11 months ago · JSON representation ·

Repository

Research compendium template for tracking, linking, and sharing data explorations

Basic Info
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Created about 8 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Contributing License Citation

README.md


layout: page title: Overview

root: .

looseleaf :leaves:

lifecycle Build Status

Research compendium template for tracking, linking, and sharing data explorations

Motivation

It is difficult to manage a linked collection of R notebooks.

bookdown is great except for a few key downsides arising from the fact that chapters are concatenated on render so that chunk labels cannot be duplicated, selective caching becomes difficult, and there can be no chapter level knitr hooks.

Features

  • rmarkdown files are only re-built if they have changed since the last rebuild

  • turn off chapter/page evaluation (or message printing) with a single knitr hook

  • a looseleaf build will continue despite evaluation errors

  • keep track of R package dependencies in DESCRIPTION

Example

https://jsta.github.io/looseleaf

Usage

  • Clone this repo

  • Do not edit the auto-generated files in _site

Workflow

  1. Create an Rmd file with the yaml header and chunk options in the provided template

  2. Add CRAN and Github package dependencies to DESCRIPTION

  3. Call make looseleaf-md from the command line (see required R packages for all projects in setup.md)

  4. Render to html (3 options)

* locally using `make serve` (see optional system dependencies in [setup.md](setup.md#dependencies-for-all-looseleaf-projects))

* remotely for public repos by enabling Github pages

* remotely for private repos by building a zip file on **Gitlab** CI (see `.gitlab-ci.yml`)

Prior art

https://github.com/swcarpentry/styles

Owner

  • Name: Jemma Stachelek
  • Login: jsta
  • Kind: user
  • Location: New Mexico, USA
  • Company: Los Alamos National Laboratory

Citation (CITATION)

Stachelek, Jemma, 2018. looseleaf: Research compendium template for tracking, linking, and sharing data explorations, GitHub repository, https://github.com/jsta/looseleaf

GitHub Events

Total
Last Year

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 400
  • Total Committers: 36
  • Avg Commits per committer: 11.111
  • Development Distribution Score (DDS): 0.763
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Greg Wilson g****n@t****m 95
jsta s****2@m****u 83
Raniere Silva r****e@r****m 58
Francois Michonneau f****u@g****m 46
Abigail Cabunoc a****c@o****a 25
Raniere Silva r****e@i****r 24
Maxim Belkin m****n@g****m 14
Katrin Leinweber k****i@p****e 7
Rémi Emonet r****t@r****e 5
David Mawdsley d****y@m****k 4
Piotr Banaszkiewicz p****r@b****g 4
William L. Close w****e 3
Raniere Silva r****7@i****r 2
Brandon Curtis b****s@g****m 2
Ian Lee l****1@l****v 2
Nick Young n****g@a****z 2
James Allen j****8@g****m 2
Jon Pipitone j****e@u****a 2
Erin Becker e****r@g****m 2
evanwill e****w@g****m 2
Andrew Sanchez i****z@g****m 1
Andy Boughton a****t 1
Timothée Poisot t****m@p****o 1
Ian Carroll i****l@s****g 1
Greg Wilson g****n@s****g 1
Bill Mills m****j@g****m 1
David Perez Suarez d****o@g****m 1
Gabriel A. Devenyi g****i@g****m 1
Joel Nothman j****n@g****m 1
Jonah Duckles j****h@d****g 1
and 6 more...

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 4
  • Total pull requests: 0
  • Average time to close issues: about 17 hours
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.25
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jsta (4)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

DESCRIPTION cran
  • checkpoint * imports
  • knitr * imports
  • rmarkdown * imports
  • stringr * imports