Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@luk-brue
luk-brue committed Feb 15, 2024
1 parent ac076c8 commit 5bf7cc4
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 73 deletions.
87 changes: 41 additions & 46 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ knitr::opts_chunk$set(
)
```

# rtutorials <a href="https://github.com/statisti-lehre/rtutorials"><img src="man/figures/hex-rtutorials.png" align="right" height="138" /></a>
# rtutorials <a href="https://github.com/statisti-lehre/rtutorials"><img src="man/figures/hex-rtutorials.png" align="right" height="138"/></a>

<!-- badges: start -->

Expand All @@ -23,10 +23,7 @@ knitr::opts_chunk$set(

<!-- badges: end -->

*This R package is currently under active development.*

By installing this package, you add `r learnr::available_tutorials("rtutorials")$name |> length()` handcrafted lessons to your RStudio Tutorials Pane.
Get to know basic statistics and R interactively and self paced.
By installing this package, you add `r learnr::available_tutorials("rtutorials")$name |> length()` handcrafted lessons to your RStudio Tutorials Pane. Get to know basic statistics and R interactively and self paced.

- **Language**: German

Expand All @@ -42,21 +39,22 @@ Copy the following code into your RStudio [console pane](https://cengel.github.i
install.packages(c("devtools", "learnr"))
devtools::install_github("statistik-lehre/rtutorials")
```

<details>
<summary style="cursor:pointer;">Installation Error Help </summary>
**Error**: If R reports an error like

```
<summary style="cursor:pointer;">Installation Error Help</summary>

**Error**: If R reports an error like

```
Error in
utils::download.file(url, path, method = method, quiet = quiet, :
Herunterladen von
‘<https://api.github.com/repos/statistik-lehre/rtutorials/tarball/HEAD>’
fehlgeschlagen
```

this could be due to the large size of the package in relation
to your download speed. `install_github()` has a default timeout of 60
seconds. Set a longer timeout with the command below and retry the installation.
this could be due to the large size of the package in relation to your download speed. `install_github()` has a default timeout of 60 seconds. Set a longer timeout with the command below and retry the installation.

``` r
options(timeout = 9999999)
Expand All @@ -65,43 +63,39 @@ devtools::install_github("statistik-lehre/rtutorials")

**Error**: Another error, although more uncommon looks like this:

```
```
Timeout was reached: [api.github.com] Resolving timed out after 10000 milliseconds
```
Solution: Try to connect to the internet. If you are connected, wait a few minutes and try again. Likely,
this error occurs because you hit the download rate limit of the GitHub API, e.g. installed too
many large packages from GitHub in a short period of time.

Solution: Try to connect to the internet. If you are connected, wait a few minutes and try again. Likely, this error occurs because you hit the download rate limit of the GitHub API, e.g. installed too many large packages from GitHub in a short period of time.

</details>

## Contents

All tutorials are in German. Here are the titles translated to English for the convenience of the English readers.

Note that tutorials are being written and published step by step, the list below includes planned tutorials as well. Look at `inst/tutorials` in the main branch, it is the most up to date way of finding out what is published at the moment.

| Block | Tutorial Subject | Tutorial name |
|---------|---------------------------------------|--------------|
| 1 | **Introduction** | `1a_intro`|
| 1 | **Exploring Functions and Arguments** | `1b_funktionen`|
| 1 | **Scientific Process** | `1c_prozess` |
| 2 | **Vectors** | `2a_vektoren` |
| 2 | **Indexing** | `2b_indizierung` |
| 2 | **Data Frames** | `2c_dataframes` |
| 3 | **Data Import** | `3a_import` |
| 3 | **Scales and Factors** | `3b_skalen` |
| 3 | **Measures of Central Tendency** | `3c_zentraletendenz` |
| 4 | Measures of Spread | |
| 4 | Visualization Basics | |
| 4 | Visualization with ggplot2 | |
| 5 | Sampling | |
| 5 | t-Tests | |
| 5 | Levene-Test | |
| 6 | Chi Squared | |
| 6 | Power Analysis | |
| 6 | Correlations | |
| 7 | Simple Linear Regression | |
| 7 | Scientific Process Long | |
| 7 | Programming Basics | |
Note that tutorials are being written and published step by step, the list below includes planned tutorials as well. Look at `inst/tutorials` in the main branch, it is the most up to date way of finding out what is published at the moment.

| Tutorial Subject | Tutorial name |
|-----------------------------------|----------------------|
| Introduction | `1a_intro` |
| Exploring Functions and Arguments | `1b_funktionen` |
| Scientific Process | `1c_prozess` |
| Vectors | `2a_vektoren` |
| Indexing | `2b_indizierung` |
| Data Frames | `2c_dataframes` |
| Data Import | `3a_import` |
| Scales and Factors | `3b_skalen` |
| Measures of Central Tendency | `3c_zentraletendenz` |
| Measures of Spread | `4a_dispersion` |
| Visualization using `ggplot2` | `4b_vis` |
| The Pipe Operator | `4c_pipe` |
| Data Wrangling | `4d_datawrangling` |
| Sampling | `5a_sampling` |
| t-tests | `5b_ttest` |
| Correlations | `6a_korrelationen` |
| Simple Linear Regression | `6b_regression` |

## Accessing the tutorials

Expand All @@ -120,25 +114,27 @@ Below is some code which achieves the same thing without a navigating a click- a
**The command way**

To list all available tutorials from `rtutorials`:
<!--Note that devtools::build_readme falsely includes the template tutorial, so just use the Knit buttton to build this and have the most recent official rtutorials package version installed on your machine. -->

```{r}
learnr::available_tutorials(package = "rtutorials")
```

And to run the individual tutorials, run:

```r
``` r
learnr::run_tutorial("name", package = "rtutorials")
```

For example:

```r
``` r
learnr::run_tutorial("1a_intro", package = "rtutorials")
```

## Contributing

Feedback and contributions are welcome!
Feedback and contributions are welcome!

If you spot a typo, some incorrect content or see just a better way to do it, you are welcome to collaborate. Either report it as an issue or even better, fix it yourself!

Expand All @@ -150,7 +146,7 @@ A **template tutorial** for the stylings we use is found at `inst/tutorials/temp

For more in depth guidelines on `learnr` tutorials, check out the [`learnr`](https://rstudio.github.io/learnr/) documentation.

Also, we try to maintain a set of `good first issues` that helps you get started with contributing to this project.
Also, we try to maintain a set of `good first issues` that helps you get started with contributing to this project.

## License

Expand All @@ -160,10 +156,9 @@ This software comes to you with an OpenSource license, because we are fond belie

However, the use is restricted to noncommercial purposes and only applies to the contents of this repository. Other course materials that you may get as one of our students are subject to copyright.


## Authorship

The tutorials are written by Lukas Bruelheide, Gesa Graf and Marie Klosterkamp, who is also leading the project.
The tutorials are written by Lukas Bruelheide, Gesa Graf and Marie Klosterkamp, who is also leading the project.

## Funding

Expand Down
52 changes: 25 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# rtutorials <a href="https://github.com/statisti-lehre/rtutorials"><img src="man/figures/hex-rtutorials.png" align="right" height="138" /></a>
# rtutorials <a href="https://github.com/statisti-lehre/rtutorials"><img src="man/figures/hex-rtutorials.png" align="right" height="138"/></a>

<!-- badges: start -->

Expand All @@ -12,9 +12,7 @@ Check](https://github.com/statistik-lehre/rtutorials/actions/workflows/tutorial_

<!-- badges: end -->

*This R package is currently under active development.*

By installing this package, you add 15 handcrafted lessons to your
By installing this package, you add 17 handcrafted lessons to your
RStudio Tutorials Pane. Get to know basic statistics and R interactively
and self paced.

Expand Down Expand Up @@ -66,6 +64,7 @@ Solution: Try to connect to the internet. If you are connected, wait a
few minutes and try again. Likely, this error occurs because you hit the
download rate limit of the GitHub API, e.g. installed too many large
packages from GitHub in a short period of time.

</details>

## Contents
Expand All @@ -78,29 +77,25 @@ list below includes planned tutorials as well. Look at `inst/tutorials`
in the main branch, it is the most up to date way of finding out what is
published at the moment.

| Block | Tutorial Subject | Tutorial name |
|-------|---------------------------------------|----------------------|
| 1 | **Introduction** | `1a_intro` |
| 1 | **Exploring Functions and Arguments** | `1b_funktionen` |
| 1 | **Scientific Process** | `1c_prozess` |
| 2 | **Vectors** | `2a_vektoren` |
| 2 | **Indexing** | `2b_indizierung` |
| 2 | **Data Frames** | `2c_dataframes` |
| 3 | **Data Import** | `3a_import` |
| 3 | **Scales and Factors** | `3b_skalen` |
| 3 | **Measures of Central Tendency** | `3c_zentraletendenz` |
| 4 | Measures of Spread | |
| 4 | Visualization Basics | |
| 4 | Visualization with ggplot2 | |
| 5 | Sampling | |
| 5 | t-Tests | |
| 5 | Levene-Test | |
| 6 | Chi Squared | |
| 6 | Power Analysis | |
| 6 | Correlations | |
| 7 | Simple Linear Regression | |
| 7 | Scientific Process Long | |
| 7 | Programming Basics | |
| Tutorial Subject | Tutorial name |
|-----------------------------------|----------------------|
| Introduction | `1a_intro` |
| Exploring Functions and Arguments | `1b_funktionen` |
| Scientific Process | `1c_prozess` |
| Vectors | `2a_vektoren` |
| Indexing | `2b_indizierung` |
| Data Frames | `2c_dataframes` |
| Data Import | `3a_import` |
| Scales and Factors | `3b_skalen` |
| Measures of Central Tendency | `3c_zentraletendenz` |
| Measures of Spread | `4a_dispersion` |
| Visualization using `ggplot2` | `4b_vis` |
| The Pipe Operator | `4c_pipe` |
| Data Wrangling | `4d_datawrangling` |
| Sampling | `5a_sampling` |
| t-tests | `5b_ttest` |
| Correlations | `6a_korrelationen` |
| Simple Linear Regression | `6b_regression` |

## Accessing the tutorials

Expand All @@ -124,6 +119,7 @@ click- and scrollable menu surface.
**The command way**

To list all available tutorials from `rtutorials`:
<!--Note that devtools::build_readme falsely includes the template tutorial, so just use the Knit buttton to build this and have the most recent official rtutorials package version installed on your machine. -->

``` r
learnr::available_tutorials(package = "rtutorials")
Expand All @@ -144,6 +140,8 @@ learnr::available_tutorials(package = "rtutorials")
#> - 4d_datawrangling : "Data Wrangling"
#> - 5a_sampling : "Stichprobenkennwerteverteilung"
#> - 5b_ttest : "t-Tests"
#> - 6a_korrelationen : "Korrelationen"
#> - 6b_regression : "Regression"
```

And to run the individual tutorials, run:
Expand Down

0 comments on commit 5bf7cc4

Please sign in to comment.