Skip to content

Commit

Permalink
updating readme containerization guid
Browse files Browse the repository at this point in the history
  • Loading branch information
Wenyu Nie committed Nov 23, 2023
1 parent 7e00ae4 commit 548a7a4
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,25 @@ When running this project for the first time, double click on the `.Rproj` file
renv::restore()
```

To run the code for the analysis, open `analysis/report.Rmd` through Rstudio and under "Run" on the top right hand side, select "Run All".
To run the code for the analysis, open `analysis/report.Rmd` through Rstudio and under "Run" on the top right hand side, select "Run All".

Users who find it difficult to manually reproduce the environment for running the analysis and rendering the report can follow the guide in the Containerization section.

## Dependencies

* `R` (version 4.3.1 or higher)
* R packages listed in [`renv.lock`](https://github.com/wenyunie/speed_dating_analysis/blob/main/renv.lock)

## Containerization

* A containerized version of the analysis has been published to Dockerhub as a [Docker Image](https://hub.docker.com/repository/docker/wenyunie/dsci522-rocker-speed-dating/general) for the convenience of replicating the computational environment.
* Researchers who are interested in reproducing the analysis result or building further analysis upon it can make use of this image and replicate the computational environment by:
* Install the latest version of [Docker engine](https://docs.docker.com/engine/install/)
* Download this project
* In the terminal, under the project root folder, run `docker-compose up -d`
* In the web browser, go to 'localhost:8787' and log into Rstudio Server with username 'rstudio' and password 'key_to_dating'
* The project is in there for you to further explore!

## License

The Speed Dating Analysis project and assocated materials are licensed under the MIT license. Please acknowledge and link to this webpage if you plan on using or re-mixing any part of this project
Expand Down

0 comments on commit 548a7a4

Please sign in to comment.