Content from Using Markdown

Last updated on 2024-06-27 | Edit this page

Overview

Questions

SH 

* What are the key processes involved in each stage of the research lifecycle 
* How do they contribute to effective research data management (RDM)?

Objectives

SH 

Gain a comprehensive understanding of the different stages in the research lifecycle and the key activities associated with each stage.
Learn to identify and describe the essential processes involved in research data management (RDM) at each stage of the research lifecycle.
Recognize the significance of effective data management practices in maintaining the quality and integrity of research data.

Introduction

Welcome to “RDM basics”! This course is designed to provide you with a comprehensive understanding of the research lifecycle and the crucial role that research data management (RDM) plays at each stage. Whether you are a novice researcher or an experienced professional, mastering these concepts and practices is essential for conducting high-quality and impactful research.

Throughout this course, we will explore the different stages of the research lifecycle, from the initial planning and proposal phase to the final stages of data preservation and reuse. By the end of the course, you will have a clear understanding of each stage and the key activities involved.

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