diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..52c1c38f0faf71d9eefc7635c87b63d7ab4fa1c1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.Rproj.user +.Rhistory +.RData +.Ruserdata +*.Rproj \ No newline at end of file diff --git a/R/README.md b/R/README.md new file mode 100644 index 0000000000000000000000000000000000000000..8dda6373778cb27a2f6bc66eaf0adb00021c05a1 --- /dev/null +++ b/R/README.md @@ -0,0 +1,7 @@ +# woRkflow + +## R + +The place to keep functions - see [template info](../template.md). + +We recommend using [roxygen](https://roxygen2.r-lib.org/) style [documentation](https://style.tidyverse.org/documentation.html). \ No newline at end of file diff --git a/analysis/README.md b/analysis/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6000e3439ec0ed4e9cdca1e45072401f7f63ff47 --- /dev/null +++ b/analysis/README.md @@ -0,0 +1,10 @@ +# woRkflow + +## analysis + +The place to put your analysis code - see [template info](../template.md). + +In most cases we use: + + * make_xxxx.R <- where we do all the heavy lifting and output object creation via drake and then render... + * xxx.Rmd <- where we report the output objects. The results go in [docs/](../docs/) \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..346a490df703e5a7a729fb0fd342ed0403312cfd --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# woRkflow + +## docs + +The place to put the **output** of your analysis code - see [template info](../template.md). + +Frequently used as the document store for github pages... \ No newline at end of file diff --git a/notData/README.md b/notData/README.md new file mode 100644 index 0000000000000000000000000000000000000000..289c3d02aed3f7b2017127d691c8bf5eeb2a8228 --- /dev/null +++ b/notData/README.md @@ -0,0 +1,7 @@ +# woRkflow + +## notData + +The place **not** to put any data - see [template info](../template.md). + +We recommend keeping your data somewhere else e.g. an institutional data store. \ No newline at end of file