From 78ae3a01faddf8be9f67a6a86ef8adb60688e8cb Mon Sep 17 00:00:00 2001 From: Ryan Peek Date: Mon, 29 Oct 2018 21:47:51 -0700 Subject: [PATCH] update README with version/build notes --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4391418..79d8834 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # R-DAVIS -R for Data Analysis & Visualization in Science + +**R for Data Analysis & Visualization in Science** + +This is the repository for website used to teach the quarter-long graduate seminar course, R-DAVIS. Course content integrates and builds on Data Carpentry Ecology lessons, and is taught as part of the curriculum for students in the Graduate Group in Ecology at the University of California, Davis, USA. + +## Package Dependencies + +Because much of the varied content found in the lessons, there are a number of package dependencies to be aware of. This list may not be complete, but before building the site locally, these packages should be installed: + +`c("tidyverse", "ggplot2", "tidyr", "readr", "dplyr", "purrr", "emojifont", +"viridis", "mapdata", "maps", "mapview", "measurements", "gapminder", "broom", +"gutenbergr", "tidytext", "patchwork", "cowplot", "hexbin", "geosphere", "ggmap", +"ggthemes", "magrittr", "leaflet", "plotly", "knitr")` + +## Build Site Locally + +The [course website](https://gge-ucd.github.io/R-DAVIS/) can be rebuilt locally by using the "`Build`" tab in RStudio. Assuming the above packages are installed on your machine: + + - Open the R-DAVIS project in RStudio. Click on the `Build` tab, and "*More*", select "*Clean All*". + - Then select `Build Website`. This process make take a few minutes. + +## Releases + +See the [`Releases`](https://github.com/gge-ucd/R-DAVIS/releases) tab in this repo to find the completed version for a given year. We expect further development of the website for future iterations as the course improves in the future. +