Skip to content

Commit

Permalink
differences for PR #145
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 8, 2024
1 parent 0242ef4 commit aa541b8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
4 changes: 2 additions & 2 deletions md5sum.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"config.yaml" "2459741082ec78d75a14dd77c7a79ff3" "site/built/config.yaml" "2024-10-01"
"index.md" "32bc80d6f4816435cc0e01540cb2a513" "site/built/index.md" "2024-10-01"
"links.md" "fe82d0a436c46f4b07b82684ed2cceaf" "site/built/links.md" "2024-10-01"
"episodes/read-cases.Rmd" "7977d13512d3f0922602f8112863edd1" "site/built/read-cases.md" "2024-10-01"
"episodes/read-cases.Rmd" "505a3d2556d248ca2a848da35277f02c" "site/built/read-cases.md" "2024-10-08"
"episodes/clean-data.Rmd" "355f1c880ed37e616c6de248bf5fffc4" "site/built/clean-data.md" "2024-10-01"
"episodes/validate.Rmd" "2c9cff27170992bd479f827fbee4d623" "site/built/validate.md" "2024-10-01"
"episodes/describe-cases.Rmd" "1ce7ad65092aa8fa51158e1387576339" "site/built/describe-cases.md" "2024-10-01"
"instructors/instructor-notes.md" "ca3834a1b0f9e70c4702aa7a367a6bb5" "site/built/instructor-notes.md" "2024-10-01"
"learners/reference.md" "106717912e909a7c8d9e3e8fea48e17d" "site/built/reference.md" "2024-10-01"
"learners/setup.md" "d1741145d14e6cebd2b9ada95d6c1156" "site/built/setup.md" "2024-10-01"
"learners/setup.md" "6da61c026b527974421841c97c09b23d" "site/built/setup.md" "2024-10-08"
"profiles/learner-profiles.md" "31b503c4b5bd1f0960ada730eca4a25e" "site/built/learner-profiles.md" "2024-10-01"
"renv/profiles/lesson-requirements/renv.lock" "ba6b3ffc3d1800538bb9107b6a5cd53e" "site/built/renv.lock" "2024-10-01"
9 changes: 4 additions & 5 deletions read-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,12 @@ Similarly, you can import files of other formats such as `tsv`, `xlsx`, ... etc.

### Why should we use the {here} package?

The `{here}` package is designed to simplify file referencing in R projects by providing a reliable way to construct file paths relative to the project root. Here are the three key reasons to use it:
The `{here}` package is designed to simplify file referencing in R projects by providing a reliable way to construct file paths relative to the project root. The main reason to use it is **Cross-Environment Compatibility**.

- **Relative Paths**: Allows you to use relative file paths with respect to the `R` Project, making your code more portable and less error-prone.
It works across different operating systems (Windows, Mac, Linux) without needing to adjust file paths.

- **Cross-Environment Compatibility**: Works across different operating systems (Windows, Mac, Linux) without needing to adjust file paths. This notation `here::here("data", "ebola_cases_2.csv")` avoids using `"data\ebola_cases_2.csv"` in some and `"data/ebola_cases_2.csv"` in others!

- **Reduces Errors**: Avoids the need to use `setwd()` or absolute paths, reducing errors in scripts shared across machines. This avoids notations like `"C:/Users/mycomputer/Documents/projects/helloworld"`.
- On Windows, paths are written using backslashes ( `\` ) as the separator between folder names: `"data\raw-data\file.csv"`
- On Unix based operating system such as macOS or Linux the forward slash ( `/` ) is used as the path separator: `"data/raw-data/file.csv"`

The `{here}` package is ideal for adding one more layer of reproducibility to your work. If you are interested in reproducibility, we invite you to [read this tutorial to increase the openess, sustainability, and reproducibility of your epidemic analysis with R](https://epiverse-trace.github.io/research-compendium/)

Expand Down
11 changes: 8 additions & 3 deletions setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,14 +248,19 @@ We suggest to use RStudio Projects.
- **Create an RStudio Project**. If needed, follow this [how-to guide on "Hello RStudio Projects"](https://docs.posit.co/ide/user/ide/get-started/#hello-rstudio-projects) to create a New Project in a New Directory.
- **Create** the `data/` folder inside the RStudio project or corresponding directory. Use the `data/` folder to **save** the data sets to download.

The directory of an RStudio Project named, for example `workshop`, should look like this:
The directory of an RStudio Project named, for example `training`, should look like this:

```
workshop/
training/
|__ data/
|__ workshop.Rproj
|__ training.Rproj
```

**RStudio Projects** allows you to use _relative file_ paths with respect to the `R` Project,
making your code more portable and less error-prone.
Avoids using `setwd()` with _absolute paths_
like `"C:/Users/MyName/WeirdPath/training/data/file.csv"`.

:::::::::::::::::::::::::::::::::

### 4. Create a GitHub Account
Expand Down

0 comments on commit aa541b8

Please sign in to comment.