Added READMEs

data/README.Rmd

@@ -3,6 +3,8 @@ output: github_document
 ---
 # About the data
 
+When `drake::r_make()` is run, the following CSV files will be downloaded to the `data` folder. Given below is a description of these CSV files their columns.
+
 ```{r setup, include=FALSE}
 knitr::opts_chunk$set(echo = TRUE)
 ```

figures/README.Rmd

@@ -0,0 +1,7 @@
+---
+output: github_document
+---
+
+# Figures
+
+This directory contains all the figures used in the tailfindr manuscript. The figures are generated by code in the R Markdown files in `reports` directory.

figures/README.md

@@ -0,0 +1,6 @@
+
+# Figures
+
+This directory contains all the figures used in the tailfindr
+manuscript. The figures are generated by code in the R Markdown files in
+`reports` directory.

reports/README.Rmd

@@ -0,0 +1,27 @@
+---
+output: github_document
+---
+
+```{r setup, include=FALSE}
+knitr::opts_chunk$set(echo = TRUE)
+```
+
+## R Markdown files 
+
+This direcotry contains all the R Markdown files for generating figure used in the tailfindr manuscript.
+
+When you run `drake::r_make()`, it will first ownload the data, consolidate the data, and then knit the R Markdown files -- present in this directory -- using the consolidated data. The html output of the R Markdown files is stored here with the same name as the R Markdown file. 
+
+## Modifiying R Markdown file to include custom analyses
+
+After you have successfully run `drake::r_make()`, you can change these R Markdown files to inlcude custom analyses. To render the modified R Markdown file, either run `drake::r_make()` again, which will automatically knit the modified R Markdown file(s), or just use the 'knit' option in R Studio. 
+
+## What is what
+#### 1. krause_niazi_et_al_dna_analysis.Rmd
+Contains all the analyses done on our DNA datasets.
+
+#### 2. krause_niazi_et_al_rna_analysis.Rmd
+Contains all the analyses done on our RNA datasets.
+
+#### 3. workman_et_al_rna_analysis.Rmd
+Contains all the analyses done on Workman et al.'s RNA datasets.

reports/README.md

@@ -0,0 +1,32 @@
+
+## R Markdown files
+
+This direcotry contains all the R Markdown files for generating figure
+used in the tailfindr manuscript.
+
+When you run `drake::r_make()`, it will first ownload the data,
+consolidate the data, and then knit the R Markdown files – present in
+this directory – using the consolidated data. The html output of the R
+Markdown files is stored here with the same name as the R Markdown file.
+
+## Modifiying R Markdown file to include custom analyses
+
+After you have successfully run `drake::r_make()`, you can change these
+R Markdown files to inlcude custom analyses. To render the modified R
+Markdown file, either run `drake::r_make()` again, which will
+automatically knit the modified R Markdown file(s), or just use the
+‘knit’ option in R Studio.
+
+## What is what
+
+#### 1\. krause\_niazi\_et\_al\_dna\_analysis.Rmd
+
+Contains all the analyses done on our DNA datasets.
+
+#### 2\. krause\_niazi\_et\_al\_rna\_analysis.Rmd
+
+Contains all the analyses done on our RNA datasets.
+
+#### 3\. workman\_et\_al\_rna\_analysis.Rmd
+
+Contains all the analyses done on Workman et al.’s RNA datasets.