Skip to content

Commit d71d25a

Browse files
authored
Merge pull request #117 from elixir-europe-training/clement-lee-patch-2
Clement lee patch 2
2 parents feec85a + 153e455 commit d71d25a

File tree

4 files changed

+585
-49
lines changed

4 files changed

+585
-49
lines changed

README.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,13 @@
1-
# Elixir Training Lesson template
1+
# Elixir Training Lesson: Literate Programming in R
22

3-
[![DOI](https://zenodo.org/badge/564252010.svg)](https://zenodo.org/badge/latestdoi/564252010)
3+
(placeholder for badge)
44

5+
This repository contains the scripts and source files for the [Elixir Training Lesson: Literate Programming in R](https://elixir-europe-training.github.io/ELIXIR-TrP-LiterateProgrammingR-CodeRep/), using the template from [this repository](https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplateInstructions-MkDocs/)
56

6-
For instruction on how to use the template, please follow this documentation:
7-
https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplateInstructions-MkDocs/
8-
9-
10-
**Any issues?** Contact Geert van Geest (@GeertvanGeest)
11-
12-
13-
14-
## If working locally
15-
16-
This website is generated with [MkDocs](https://www.mkdocs.org/), with the theme [Material](https://squidfunk.github.io/mkdocs-material/).
17-
18-
To host it locally, install MkDocs:
19-
```bash
20-
pip install mkdocs
21-
```
22-
23-
and Material with some plugins:
24-
```bash
25-
pip install mkdocs-material
26-
pip install mkdocs-video
27-
pip install mkdocs-bibtex
28-
pip install neoteroi-mkdocs
29-
```
30-
31-
Clone this repository to your local computer. Then, make the repository your current directory and type:
32-
33-
```bash
34-
mkdocs serve
35-
```
36-
37-
To host it locally.
38-
39-
Check it out with your browser at [http://localhost:8000/](http://localhost:8000/).
40-
7+
While the training can be completed without referring to this repository at all, comprehension of how the source files lead to the webpages is an indicator of successful completion of the training, as the content i.e. literate programming **is** the way the webpages have been written.
418

429
## Citation
4310

4411
Please cite as
4512

46-
> Geert van Geest, Elin Kronander, Jose Alejandro Romero Herrera, Nadja Žlender, & Alexia Cardona. (2023).
47-
> The ELIXIR Training Lesson Template - Developing Training Together (v1.0.0-alpha). Zenodo.
48-
> https://doi.org/10.5281/zenodo.7913092
13+
(placeholder for citation)

docs/chapters/Chapter_04.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ Check out the [Quarto gallery](https://quarto.org/docs/gallery/) to see its capa
2121
In this part of the tutorial, we'll focus on using Quarto with R. But remember, Quarto isn't limited to [R](https://quarto.org/docs/computations/r.html) — it also works with Python, Julia, and Observable JS!
2222

2323
### Installation Guide
24-
Before we start, it's essential to set up our environment. Here's what you need:
24+
Before we start, it's essential to set up our environment. Here's what you need (you should already have the first three from the [software setup](../../#software-setup)):
2525

2626
1. **RStudio Installation**: Ensure you have the latest version of RStudio. This will provide the best compatibility with Quarto.
2727

28-
2. **Quarto Installation:** Visit the [Quarto website](https://quarto.org/) for installation instructions. For a more detailed guide, check out the [Quarto guide]([https://quarto.org/](https://quarto.org/docs/guide/)). Make sure to follow the steps appropriate for your operating system.
28+
2. **Quarto Installation**: Visit the [Quarto website](https://quarto.org/) for installation instructions. For a more detailed guide, check out the [Quarto guide]([https://quarto.org/](https://quarto.org/docs/guide/)). Make sure to follow the steps appropriate for your operating system.
2929

30-
3. **TinyTeX Setup**
30+
3. **TinyTeX Setup**:
3131
TinyTeX is a minimal TeX distribution specifically tailored for Quarto, which you'll need for generating PDFs. Here's how to install it:
3232
- Open RStudio, navigate to *Tools* > *Terminal* > *New Terminal*.
3333
- In the terminal, type *quarto install tinytex* to start the installation process.
3434

35-
4. **Update R Packages**
35+
4. **Update R Packages**:
3636
To ensure smooth operation with Quarto, update the following R packages by running this command in RStudio:
3737

3838
```R

0 commit comments

Comments
 (0)