Content from Publishing a software? Why?
Last updated on 2024-06-25 | Edit this page
Overview
Questions
- Why would you publish your software?
- What does it mean to publish a software?
- Where can you publish it?
Objectives
- Explain how to use markdown with The Carpentries Workbench
- Demonstrate how to include pieces of code, figures, and nested challenge blocks
Research Software Engineering: Evidence of work and incresing impact
Publishing your software: what does it mean?
Where to publish?
Content from The Author's side: Requirements for a JOSS submission
Last updated on 2024-06-25 | Edit this page
Overview
Questions
- Can I submit whatever code I have created?
- How do I get ready for submision?
Objectives
- Understand what kind of software can be published in JOSS
- Be able to create a JOSS paper
what can you submit to JOSS?
What does your software need to be publishable?
The JOSS paper
Submit your work!!!
Content from Behind the curtain: The editor/reviewer's side
Last updated on 2024-06-25 | Edit this page
Overview
Questions
- What happens when you make your submission?
- How do you get your submission accepted?
Objectives
- Understand how the review process works
- Understand what is the reviewer looking for
Receiving a submission
Pre - review
Review
Content from The submission and review process [video]
Last updated on 2024-05-16 | Edit this page
Overview
Questions
- Why would you publish your software?
- What does it mean to publish a software?
- Where can you publish it?
Objectives
- Explain how to use markdown with The Carpentries Workbench
- Demonstrate how to include pieces of code, figures, and nested challenge blocks
Introduction
This is a lesson created via The Carpentries Workbench. It is written in Pandoc-flavored Markdown for static files and R Markdown for dynamic files that can render code into output. Please refer to the Introduction to The Carpentries Workbench for full documentation.
What you need to know is that there are three sections required for a valid Carpentries lesson:
-
questions
are displayed at the beginning of the episode to prime the learner for the content. -
objectives
are the learning objectives for an episode displayed with the questions. -
keypoints
are displayed at the end of the episode to reinforce the objectives.
Challenge 1: Can you do it?
What is the output of this command?
R
paste("This", "new", "lesson", "looks", "good")
OUTPUT
[1] "This new lesson looks good"
Challenge 2: how do you nest solutions within challenge blocks?
You can add a line with at least three colons and a
solution
tag.
Figures
You can use standard markdown for static figures with the following syntax:
{alt='alt text for accessibility purposes'}
Callout
Callout sections can highlight information.
They are sometimes used to emphasise particularly important points but are also used in some lessons to present “asides”: content that is not central to the narrative of the lesson, e.g. by providing the answer to a commonly-asked question.
Math
One of our episodes contains \(\LaTeX\) equations when describing how to create dynamic reports with {knitr}, so we now use mathjax to describe this:
$\alpha = \dfrac{1}{(1 - \beta)^2}$
becomes: \(\alpha = \dfrac{1}{(1 - \beta)^2}\)
Cool, right?
Key Points
- Use
.md
files for episodes when you want static content - Use
.Rmd
files for episodes when you need to generate output - Run
sandpaper::check_lesson()
to identify any issues with your lesson - Run
sandpaper::build_lesson()
to preview your lesson locally