Skip to content

Commit

Permalink
update README with version/build notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanpeek committed Oct 30, 2018
1 parent e180175 commit 78ae3a0
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 78ae3a0

Please sign in to comment.