diff --git a/inst/templates/README-comp.Rmd b/inst/templates/README-comp.Rmd index 485a3f9..5462778 100644 --- a/inst/templates/README-comp.Rmd +++ b/inst/templates/README-comp.Rmd @@ -24,7 +24,8 @@ knitr::opts_chunk$set(collapse = TRUE,
• Overview
- • Features
+ • Data sources
+ • Workflow
• Content
• Installation
• Usage
@@ -38,14 +39,28 @@ knitr::opts_chunk$set(collapse = TRUE,
## Overview
-This research compendium... **{{ DESCRIBE YOUR PROJECT }}**
+This project is dedicated to... **{{ DESCRIBE YOUR PROJECT }}**
-## Features
+## Data sources
-The main purpose of this compendium is to... **{{ DESCRIBE THE MAIN FEATURES }}**
+This project uses the following databases:
+**{{ DESCRIBE THE DATA SOURCES }}**
+
+
+
+
+## Workflow
+
+The analysis pipeline follows these steps:
+
+**{{ DESCRIBE THE PIPELINE }}**
## Content
@@ -61,7 +76,7 @@ main R script to run the entire project
- [`R/`](https://github.com/{{github}}/{{project_name}}/tree/{{branch}}/R):
contains R functions developed especially for this project
-- **{{ LIST ADDITIONAL FILES/FOLDER }}**
+**{{ LIST ADDITIONAL FILES/FOLDER }}**