Skip to content

Commit

Permalink
Add Rproject file to root (AlexsLemonade#129)
Browse files Browse the repository at this point in the history
* Add .Rproj file at root

Adds an R Project file with some sensible defaults for reproducibility. 
Updates README file to note its presence and reasoning.
Update .gitignore to include .Rproj.user

* Update to README

Add note on local development.
  • Loading branch information
jashapiro authored and jaclyn-taroni committed Sep 26, 2019
1 parent a3a77ad commit a7b988a
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.DS_Store
.Rhistory
.Rproj.user
# The dictionary of words accrued by `mdspell` for spellcheck
.spelling

Expand Down
14 changes: 14 additions & 0 deletions OpenPBTA-analysis.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Version: 1.0

RestoreWorkspace: No
SaveWorkspace: No
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX
DisableExecuteRprofile: Yes
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,16 @@ The username will for login will be `rstudio` and the password will be whatever

If you are a new user, you may find [these instructions](https://github.com/AlexsLemonade/RNA-Seq-Exercises/blob/master/docker-pull.md) for a setting up a different Docker container or [this guide](https://www.andrewheiss.com/blog/2017/04/27/super-basic-practical-guide-to-docker-and-rstudio/) from Andrew Heiss helpful.

### Local Development

While we encourage development within the Docker container, it is also possible to conduct analysis without Docker if that is desired.
In this case, it is important to ensure that local or personal settings such as file paths or installed packages and libraries are not assumed in the analysis.

#### RStudio

We have supplied an RStudio project (`OpenPBTA-analysis.Rproj`) file at the root of the project to aid in organization and encourage reproducible defaults for analysis.
In particular, we do not source `.Rprofile` files in new sessions or save/restore workspaces.

### Continuous Integration (CI)

We use continuous integration (CI) to ensure that the project Docker image will build if there are any changes introduced to the [`Dockerfile`](https://github.com/AlexsLemonade/OpenPBTA-analysis/blob/master/Dockerfile) and that all analysis code will execute.
Expand Down

0 comments on commit a7b988a

Please sign in to comment.