README.md

Author

Søren O’Neill

Published

January 10, 2024

1 Commenting your project

Maintain a README.md file in each project, at the root level

  • A simple description of the project purpose (the ‘why’)
  • People involved
  • Data sources etc
  • List most important components (data and files)

Especially important for larger, more complex projects with many data sources, collaborators, etc

1.1 README.md template

#| eval: false
#| echo: true
# Project title

A subtitle that describes your project, e.g., research question

## Motivation

Motivate your research question or business problem. Clearly explain which problem is solved.

## Method and results

First, introduce and motivate your chosen method, and explain how it contributes to solving the research 
question/business problem.

Second, summarize your results concisely. Make use of subheaders where appropriate.


## Repository overview

Provide an overview of the directory structure and files, for example:

├── README.md
├── data
│   ├── my_data.csv  # raw data from CPR register
│   ├── exp_data.csv # experimental data register
├── plots
│   ├── plot_1.png   # Boxplot of age
│   ├── plot_2.png   # Pi chart of sex
│   └── plot_3.png   # Bi-plot age vs measurement X
├── main.R           # all analyses in one place
└── manuscript1.Rmd  # for J of RR

## Running instructions

Explain to potential users how to run/replicate your workflow. If necessary, touch upon the required input 
data, which secret credentials are required (and how to obtain them), which software tools are needed 
to run the workflow (including links to the installation instructions), and how to run the workflow.

## More resources

Point interested users to any related literature and/or documentation.

## About

Explain who has contributed to the repository.