Skip to content

Commit ee7bc5a

Browse files
Merge pull request #227 from UBC-DSCI/dev
Big dev -> master merge!
2 parents fae61d3 + de182be commit ee7bc5a

File tree

334 files changed

+46418
-22515
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

334 files changed

+46418
-22515
lines changed

01-reading.Rmd

Lines changed: 0 additions & 636 deletions
This file was deleted.

02-wrangling.Rmd

Lines changed: 0 additions & 550 deletions
This file was deleted.

04-version_control.Rmd

Lines changed: 0 additions & 603 deletions
This file was deleted.

06-classification_continued.Rmd

Lines changed: 0 additions & 570 deletions
This file was deleted.

07-regression1.Rmd

Lines changed: 0 additions & 579 deletions
This file was deleted.

08-regression2.Rmd

Lines changed: 0 additions & 482 deletions
This file was deleted.

09-clustering.Rmd

Lines changed: 0 additions & 605 deletions
This file was deleted.

10-inference.Rmd

Lines changed: 0 additions & 887 deletions
This file was deleted.

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,32 @@ This is the source for the Introduction to Data Science textbook.
33

44
## Setup and Build
55

6-
1. Install Docker (instructions here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/))
6+
In order to build the book, you need to first install Docker
7+
(instructions here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)).
8+
Then obtain the build image via
9+
```
10+
docker pull ubcdsci/intro-to-ds
11+
```
12+
From this point you have two options:
13+
14+
- use whatever text editor you want, and build the book on the command line
15+
- use RStudio to both edit and build the book
16+
17+
We provide instructions for both methods here.
18+
19+
### Without RStudio
720

8-
2. Run RStudio inside the `ubcdsci/intro-to-ds` docker container:
21+
Once you are done editing, navigate to the repository root folder and run
22+
```
23+
./build.sh
24+
```
25+
from the command line. This command automatically spawns a docker container
26+
with the `ubcdsci/intro-to-ds` image, runs the script `build.R` from within the container,
27+
and then stops the container.
28+
29+
### With RStudio
30+
31+
1. Run RStudio inside the `ubcdsci/intro-to-ds` docker container:
932
- in terminal, navigate to the root of this project repo
1033
- type the following in terminal:
1134

@@ -17,7 +40,7 @@ This is the source for the Introduction to Data Science textbook.
1740
1841
> Alternatively, you can type:
1942
> ```
20-
> docker run --rm -it -p 8787:8787 -v $PWD:/home/rstudio/introduction-to-datascience -e PASSWORD=password ubcdsci/intro-to-ds:v0.1.0
43+
> docker run --rm -it -p 8787:8787 -m 4g -v $PWD:/home/rstudio/introduction-to-datascience -e PASSWORD=password ubcdsci/intro-to-ds:v0.1.0
2144
> ```
2245
2346
Next:
@@ -32,18 +55,6 @@ This is the source for the Introduction to Data Science textbook.
3255
bookdown::render_book('index.Rmd', 'bookdown::gitbook')
3356
```
3457
35-
> ### Usage without RStudio
36-
> You can use this docker container to edit the files without RStudio using either vim or emacs. This can be done via:
37-
>
38-
> ```
39-
> docker-compose run --rm book-env bash
40-
> ```
41-
>
42-
> or via:
43-
> ```
44-
> docker run --rm -it -v $PWD:/introduction-to-datascience ubcdsci/intro-to-ds /bin/bash
45-
> ```
46-
4758
### Updating the textbook data
4859
Data sets are collected and curated by `data/retrieve_data.ipynb`. To run that notebook in the Docker container type the following in the terminal:
4960

_bookdown.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ language:
33
ui:
44
chapter_name: "Chapter "
55
delete_merged_file: true
6+
rmd_files: ["index.Rmd", "intro.Rmd", "reading.Rmd", "wrangling.Rmd", "viz.Rmd", "classification1.Rmd", "classification2.Rmd", "regression1.Rmd", "regression2.Rmd", "clustering.Rmd", "inference.Rmd", "jupyter.Rmd", "version-control.Rmd", "setup.Rmd", "references.Rmd"]

0 commit comments

Comments
 (0)