Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add steps to rstudio project and github account #85

Merged
merged 2 commits into from
Jun 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions learners/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

The tutorials are built around an outbreak analysis pipeline split into three stages: **Early tasks**, **Middle tasks** and **Late tasks**.

![An overview of the tutorial topics](https://epiverse-trace.github.io/task_pipeline-minimal.svg)

Check warning on line 15 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[image missing alt-text]: https://epiverse-trace.github.io/task_pipeline-minimal.svg

Each task has its tutorial website. Each tutorial website consists of a set of episodes.

Expand All @@ -29,13 +29,13 @@
+ **Challenges**: complete challenges to test your understanding.
+ **Explainers**: add to your understanding of mathematical and modelling concepts with the explainer boxes.

Also check out the [glossary](../reference.md) for any terms you may be unfamiliar with.

Check warning on line 32 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[missing file]: [glossary](../reference.md)

### Epiverse-TRACE R packages

Our strategy is to gradually incorporate specialised **R packages** into a traditional analysis pipeline. These packages should fill the gaps in these epidemiology-specific tasks in response to outbreaks.

![In **R**, the fundamental unit of shareable code is the **package**. A package bundles together code, data, documentation, and tests and is easy to share with others ([Wickham and Bryan, 2023](https://r-pkgs.org/introduction.html))](episodes/fig/pkgs-hexlogos-2.png).

Check warning on line 38 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[image missing alt-text]: episodes/fig/pkgs-hexlogos-2.png

:::::::::::::::::::::::::::: prereq

Expand Down Expand Up @@ -235,6 +235,42 @@

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)!

### 3. Setup an RStudio project and folder

We suggest to use RStudio Projects.

::::::::::::::::::::::::::::::::: checklist

#### Follow these steps

- **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:

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

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

### 4. Create a GitHub Account

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).

::::::::::::::::::::::::::::::::: checklist

#### Follow all these steps

1. Go to <https://github.com> and follow the "Sign up" link at the top-right of the window.
2. Follow the instructions to create an account.
3. Verify your email address with GitHub.
<!-- 4. Configure the Multi-factor Authentication (see below).-->

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

## Data sets

### Download the data
Expand Down
Loading