Skip to content

Commit 96886af

Browse files
committed
update rtools as previous step
1 parent bc08662 commit 96886af

File tree

1 file changed

+36
-32
lines changed

1 file changed

+36
-32
lines changed

learners/setup.md

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,38 @@ While this may sound scary, it is **far more common** to run into issues due to
114114

115115
:::::::::::::::::::::::::::::
116116

117-
### 2. Install the required R packages
117+
### 2. Install build tools
118+
119+
Some packages require a complementary set of tools to build them. To check if you have them, run:
120+
121+
```r
122+
if(!require("pkgbuild")) install.packages("pkgbuild")
123+
pkgbuild::check_build_tools(debug = TRUE)
124+
```
125+
126+
We expect a message like the one below:
127+
128+
```output
129+
Your system is ready to build packages!
130+
```
131+
132+
If the build tools are not available, this will trigger an automated install.
133+
Wait until to get the expected output message.
134+
We suggest to restart your R session or close and open back again RStudio to let it recognize this new installation.
135+
136+
::::::::::::::::::::::::::::: spoiler
137+
138+
### What to do if this step does not work?
139+
140+
Windows users will need a working installation of `Rtools` in order to build the package from source. `Rtools` is not an R package, but a software you need to download and install. We suggest you to follow:
141+
142+
- **Install `Rtools`**. Download the `Rtools` installer from <https://cran.r-project.org/bin/windows/Rtools/>. Install with default selections.
143+
- Close and open back again RStudio to let it recognize this new installation.
144+
145+
:::::::::::::::::::::::::::::
146+
147+
148+
### 3. Install the required R packages
118149

119150
<!--
120151
During the tutorial, we will need a number of R packages. Packages contain useful R code written by other people. We will use packages from the [Epiverse-TRACE](https://epiverse-trace.github.io/).
@@ -157,6 +188,7 @@ new_packages <- c(
157188
"socialmixr",
158189
"finalsize",
159190
"epiverse-trace/epidemics",
191+
"odin",
160192
"scales"
161193
)
162194

@@ -167,34 +199,6 @@ These installation steps could ask you `? Do you want to continue (Y/n)` write `
167199

168200
::::::::::::::::::::::::::::: spoiler
169201

170-
### do you get an error with EpiNow2?
171-
172-
Windows users will need a working installation of `Rtools` in order to build the package from source. `Rtools` is not an R package, but a software you need to download and install. We suggest you to follow:
173-
174-
<!-- reference [these steps](http://jtleek.com/modules/01_DataScientistToolbox/02_10_rtools/#1) -->
175-
176-
1. **Verify `Rtools` installation**. You can do so by using Windows search across your system. Optionally, you can use `{devtools}` running:
177-
178-
```r
179-
if(!require("devtools")) install.packages("devtools")
180-
devtools::find_rtools()
181-
```
182-
183-
If the result is `FALSE`, then you should do step 2.
184-
185-
2. **Install `Rtools`**. Download the `Rtools` installer from <https://cran.r-project.org/bin/windows/Rtools/>. Install with default selections.
186-
187-
3. **Verify `Rtools` installation**. Again, we can use `{devtools}`:
188-
189-
```r
190-
if(!require("devtools")) install.packages("devtools")
191-
devtools::find_rtools()
192-
```
193-
194-
:::::::::::::::::::::::::::::
195-
196-
::::::::::::::::::::::::::::: spoiler
197-
198202
### do you get an error with epiverse-trace packages?
199203

200204
For example, if you get an error message when installing `{simulist}`, try this alternative code:
@@ -301,7 +305,7 @@ library(scales)
301305

302306
If you do NOT see an error like `there is no package called ‘...’` you are good to go! If you do, [contact us](#your-questions)!
303307

304-
### 3. Setup an RStudio project and folder
308+
### 4. Setup an RStudio project and folder
305309

306310
We suggest to use RStudio Projects.
307311

@@ -327,7 +331,7 @@ like `"C:/Users/MyName/WeirdPath/training/data/file.csv"`.
327331

328332
:::::::::::::::::::::::::::::::::
329333

330-
### 4. Create a GitHub Account
334+
### 5. Create a GitHub Account
331335

332336
We can use [GitHub](https://github.com) as a collaboration platform to communicate package issues and engage in [community discussions](https://github.com/orgs/epiverse-trace/discussions).
333337

@@ -342,7 +346,7 @@ We can use [GitHub](https://github.com) as a collaboration platform to communica
342346

343347
:::::::::::::::::::::::::::::::::
344348

345-
### 5. Watch and Read the pre-training material
349+
### 6. Watch and Read the pre-training material
346350

347351
:::::::::::::::::::::::::::: prereq
348352

0 commit comments

Comments
 (0)