Content from Using Markdown

Last updated on 2023-07-24 | Edit this page

Overview

Questions

  • How do you write a lesson using Markdown and sandpaper?

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:

  1. questions are displayed at the beginning of the episode to prime the learner for the content.
  2. objectives are the learning objectives for an episode displayed with the questions.
  3. 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:

![optional caption that appears below the figure](figure url){alt='alt text for accessibility purposes'}

Blue Carpentries hex person logo with no text.
You belong in The Carpentries!

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

Content from The concept of relational databases vs. spreadsheets

Last updated on 2024-09-13 | Edit this page

Overview

Questions

  • How is data stored in a spreadsheet?
  • How is data stored in a relational database?
  • What is the differences between spreadsheets and relational databeses?

Objectives

  • Define the basic components of a spreadsheet.
  • Define the basic components of a relational database
  • Converting spreadsheets into a relational databases on a sample dataset.

TODO

Challenge

To recap all the terms you learned just now: Which properties apply to relational databases?

right aswer

Key Points

  • keypoint 1
  • keypoint 2

Content from Introduction to the NocoDB interface

Last updated on 2024-09-13 | Edit this page

Overview

Questions

  • How is the interface structured?
  • How do you create a new base?

Objectives

  • Create a new base
  • Explain the structure of the NocoDB interface

Challenge

Create a new table for your data

Click on new base and in this base create a table

Content from Dataimport to NOCODB

Last updated on 2024-09-13 | Edit this page

Overview

Questions

  • How do you add something which is not existing?

Objectives

  • nothing at all
  • nothing more

Introduction

not yet added

Challenge

What is the question?

The answer is a number.

84

Key Points

  • Use NocoDB
  • Add data
  • Display data
  • Visualize data in NocoDB