Science Score: 54.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
    17 of 80 committers (21.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords from Contributors

english lesson stable carpentries-lab life-sciences metagenomics carpentries carpentries-incubator alpha training
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: sstevens2
  • License: other
  • Language: HTML
  • Default Branch: gh-pages
  • Size: 8.65 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 6 years ago · Last pushed over 6 years ago
Metadata Files
Readme Contributing License Code of conduct Citation Authors

README.md

Build Status

lesson-example

Create a Slack Account with us

This repository shows how to create a lesson using The Carpentries lesson template, and is itself an example of the use of that template. Please see https://carpentries.github.io/lesson-example/ for a rendered version of this material, including detailed instructions on design, setup, and formatting.

Quick Instructions

  1. Do not fork this repository directly on GitHub. Instead, please follow the instructions in the setup instructions to create a repository for your lesson by importing material from the styles repository.

  2. Once you have created your repository, run bin/lesson_initialize.py to create standard lesson-specific files. You must edit several values in _config.yml so that GitHub Pages will render your lesson correctly.

  3. Please read the episodes of this lesson to format your material.

  4. Please keep the master copy of your lesson in your repository's gh-pages branch, since that is what is automatically published as a website by GitHub.

  5. To preview material, please run make serve from the command line to launch Jekyll with the correct parameters, or push to your repository's gh-pages branch and let GitHub take care of the rendering.

  6. Run make lesson-check to check that your files follow our formatting rules.

  7. If you find an error or omission in this documentation, please file an issue in this repository. If you find an error or omission in the lesson template, please file an issue in the styles repository instead.

Layout

The layout of this repository is explained in this site's episodes. In brief:

  1. The source for pages that appear as top-level items in the navigation bar are stored in the root directory, including the home page (index.md), the reference page (reference.md), and the setup instructions (setup.md).

  2. Source files for lesson episodes are stored in _episodes; _episodes/01-xyz.md generates /01-xyz/index.html, which can be linked to using /01-xyz/.

  3. If you are writing lessons in R Markdown, source files go in _episodes_rmd. You must run make lesson-rmd to turn these into Markdown in _episodes and commit those Markdown files to the repository (since GitHub won't run anything except Jekyll to format material). You must also commit any figures generated from your lessons, which are stored in the fig directory.

  4. Files that appear under the "extras" menu are stored in _extras.

  5. Figures are stored in the fig directory, data sets in data, source code in code, and miscellaneous files in files.

Getting Started

  1. Run bin/lesson_initialize.py to create files that can't be stored in the template repository (because they would cause repeated merge conflicts), then edit _config.yml as described in the documentation.

  2. Run make lesson-check at any time to check that your lesson files follow our formatting rules. If you come across formatting issues that the checker doesn't report, please file an issue in the styles repository.

  3. For a list of helpful commands run make in this directory. If you are looking for things to work on, please see the list of issues for this repository.

Owner

  • Name: Sarah Stevens
  • Login: sstevens2
  • Kind: user
  • Location: Madison, WI
  • Company: @UW-Madison-DataScience

I'm a Facilitator for the UW-Madison Data Science Hub. My PhD work was studying the population dynamics of bacteria in freshwater lakes.

Citation (CITATION)

Please cite as:

Greg Wilson (ed.): "Software Carpentry: Lesson Example."  Version
2016.06, June 2016, https://github.com/carpentries/lesson-example,
10.5281/zenodo.58153.

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 1,107
  • Total Committers: 80
  • Avg Commits per committer: 13.838
  • Development Distribution Score (DDS): 0.603
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@s****g 439
Raniere Silva r****e@r****m 197
François Michonneau f****u@g****m 107
Maxim Belkin m****n@g****m 57
Andy Boughton a****t@g****m 32
Abigail Cabunoc Mayes a****c@g****m 25
Rémi Emonet r****i@h****m 21
Katrin Leinweber 9****r 20
W. Trevor King w****g@t****s 20
maneesha sane m****e@g****m 14
Aaron O'Leary a****y@g****m 14
Erin Becker e****r@g****m 12
Chris Erdmann c****s@c****g 9
Jonah Duckles j****h@d****g 6
James Allen j****s@s****m 5
John Blischak j****k@g****m 5
Piotr Banaszkiewicz p****r@b****g 5
Rayna M Harris r****s 5
Joseph Stachelek j****a 5
Michael R. Crusoe 1****c 4
David Mawdsley d****y@m****k 4
Kate Hertweck k****k@g****m 4
Naupaka Zimmerman n****a@g****m 4
Tracy Teal t****l@g****m 3
Ivan Gonzalez i****c@g****m 3
Pete h****r 3
Pete Bachant p****t@g****m 3
Sarah Stevens s****s@w****u 3
Stijn Van Hoey s****y@g****m 3
Trevor Bekolay t****y@g****m 3
and 50 more...

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total 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
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
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels