code-publishing

A minimal reproducible example for the workshop on Quarto manuscripts. Also includes a reproducibility checklist and instructions for creating your own workflow with your existing project.

https://github.com/lmu-osc/code-publishing

Science Score: 75.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
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
    Organization lmu-osc has institutional domain (www.osc.uni-muenchen.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A minimal reproducible example for the workshop on Quarto manuscripts. Also includes a reproducibility checklist and instructions for creating your own workflow with your existing project.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 2
  • Open Issues: 34
  • Releases: 1
Created almost 2 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Citation

README.md

DOI

Code Publishing Tutorial

This repository contains a tutorial on code publishing created for the LMU Open Science Center. It can be viewed online at https://lmu-osc.github.io/code-publishing/.

The tutorial pages are contained in the *.qmd files in the root folder. All images are contained in the folder images.

Previewing and rendering the tutorial

The tutorial is written in Markdown and uses Quarto to render it as a website. To render the tutorial on your own computer, you need to have Quarto installed.

Further, the R package renv is used to track the project's dependencies.

One can install renv as follows in R:

r install.packages("renv")

Then, also from within R, one can restore the dependencies tracked with renv:

r renv::restore()

While you are working on the tutorial, you can preview it as follows:

sh quarto preview

This will open the tutorial in your browser. If you make any changes, the website will automatically reload.

If you are done editing and would like to render the tutorial to a static website, run the following:

sh quarto render

Contributing

If you are contributing to this tutorial, please read the contributing notes before.

License

Except where noted otherwise, the narrative text in this tutorial is licensed under CC BY-SA 4.0; the code without any narrative text is also (at your option) available under CC0 1.0.

Owner

  • Name: LMU Open Science Center
  • Login: lmu-osc
  • Kind: organization
  • Location: Germany

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this tutorial, please cite it as below."
authors:
  - given-names: Florian
    family-names: Kohrt
    orcid: 'https://orcid.org/0000-0003-0374-5625'
    affiliation: "LMU Munich"
    email: fkohrt@anche.no
  - given-names: Josephine
    family-names: Zerna
    orcid: 'https://orcid.org/0000-0003-2892-884X'
  - given-names: Christoph
    family-names: Scheffel
    orcid: 'https://orcid.org/0000-0001-5963-9229'
title: "Code Publishing Tutorial"
version: 0.1.0
doi: "10.5281/zenodo.16631977"
date-released: 2025-07-31
repository-code: 'https://github.com/lmu-osc/code-publishing'
url: 'https://lmu-osc.github.io/code-publishing/'
preferred-citation:
  authors:
   - given-names: Florian
     family-names: Kohrt
     orcid: 'https://orcid.org/0000-0003-0374-5625'
     email: fkohrt@anche.no
   - given-names: Josephine
     family-names: Zerna
     orcid: "https://orcid.org/0000-0003-2892-884X"
   - given-names: Christoph
     family-names: Scheffel
     orcid: 'https://orcid.org/0000-0001-5963-9229'
  title: "Code Publishing Tutorial"
  year: 2025
  doi: "10.5281/zenodo.16631977"
  publisher:
    name: "LMU Open Science Center"
    ror: "https://ror.org/029e6qe04"
  repository-code: 'https://github.com/lmu-osc/code-publishing'
  url: 'https://lmu-osc.github.io/code-publishing/'
  type: "book"

GitHub Events

Total
  • Create event: 7
  • Commit comment event: 1
  • Release event: 1
  • Issues event: 69
  • Delete event: 4
  • Issue comment event: 80
  • Push event: 105
  • Pull request review comment event: 7
  • Pull request review event: 9
  • Pull request event: 14
  • Fork event: 1
Last Year
  • Create event: 7
  • Commit comment event: 1
  • Release event: 1
  • Issues event: 69
  • Delete event: 4
  • Issue comment event: 80
  • Push event: 105
  • Pull request review comment event: 7
  • Pull request review event: 9
  • Pull request event: 14
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 40
  • Total pull requests: 8
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 7
  • Total pull request authors: 5
  • Average comments per issue: 0.85
  • Average comments per pull request: 0.75
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 39
  • Pull requests: 8
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 12 days
  • Issue authors: 6
  • Pull request authors: 5
  • Average comments per issue: 0.82
  • Average comments per pull request: 0.75
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • fkohrt (20)
  • SvonGrebmer (16)
  • NeuroShepherd (9)
  • MalikaIhle (7)
  • FlorianPargent (6)
  • DejanaDam (1)
  • AlbertoImg (1)
Pull Request Authors
  • NeuroShepherd (6)
  • fkohrt (1)
  • nicebread (1)
  • Gnotic (1)
  • Riyaaa1 (1)
Top Labels
Issue Labels
help wanted (1)
Pull Request Labels

Dependencies

.github/workflows/publish.yml actions
  • actions/checkout v4 composite
  • quarto-dev/quarto-actions/publish v2 composite
  • quarto-dev/quarto-actions/setup v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-renv v2 composite