Skip to content

Commit d615b21

Browse files
Refactor ready for website
1 parent 3b57488 commit d615b21

18 files changed

+131
-130
lines changed

_config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,11 @@ execute:
9191
- 'individual_modules/improve_your_r_code/data_table.ipynb'
9292
- 'individual_modules/improve_your_r_code/parallelisation.ipynb'
9393
- 'individual_modules/improve_your_r_code/rcpp.ipynb'
94+
- 'individual_modules/Introduction_to_Markdown_in_R/Background_to_Markdown.md'
95+
- 'individual_modules/Introduction_to_Markdown_in_R/Course_Outro.md'
96+
- 'individual_modules/Introduction_to_Markdown_in_R/Getting_Started_with_Markdown_in_R.md'
97+
- 'individual_modules/Introduction_to_Markdown_in_R/Processing_RMarkdown_Files.md'
98+
- 'individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_Embedded_Code.md'
99+
- 'individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_Formatted_Text.md'
100+
- 'individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_Visual_Prelude.md'
101+
- 'individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_YAML_Header.md'

_static/multiple_regression_hyperplane.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_static/multiple_regression_hyperplane_2.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_static/workshops_network_hpc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ <h1></h1>
282282

283283

284284
// parsing and collecting nodes and edges from the python
285-
nodes = new vis.DataSet([{"color": "#FFD700", "id": "Introduction to HPC", "label": "Introduction to HPC", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Introduction to HPC\nCourse Pre-reqs: Introduction to Unix\nSubsequent Courses: Parallel Computing"}, {"color": "#FFD700", "id": "Parallel Computing", "label": "Parallel Computing", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Parallel Computing\nCourse Pre-reqs: Introduction to HPC\nSubsequent Courses: None"}, {"color": "#FFD700", "id": "Introduction to Unix", "label": "Introduction to Unix", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Unix\nCourse Pre-reqs: None\nSubsequent Courses: Introduction to HPC, Introduction to Version Control with Git and GitHub"}, {"color": "#FFD700", "id": "Introduction to Version Control with Git and GitHub", "label": "Introduction to Version Control with Git and GitHub", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Version Control with Git and GitHub\nCourse Pre-reqs: Introduction to Unix\nSubsequent Courses: Intermediate Version Control"}, {"color": "#FFD700", "id": "Intermediate Version Control", "label": "Intermediate Version Control", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Intermediate Version Control\nCourse Pre-reqs: Introduction to Version Control with Git and GitHub\nSubsequent Courses: None"}, {"color": "#FFD700", "id": "Introduction to Python", "label": "Introduction to Python", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Python\nCourse Pre-reqs: None\nSubsequent Courses: None"}]);
285+
nodes = new vis.DataSet([{"color": "#4682B4", "id": "Introduction to HPC", "label": "Introduction to HPC", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Introduction to HPC\nCourse Pre-reqs: Introduction to Unix\nSubsequent Courses: Parallel Computing"}, {"color": "#4682B4", "id": "Parallel Computing", "label": "Parallel Computing", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Parallel Computing\nCourse Pre-reqs: Introduction to HPC\nSubsequent Courses: None"}, {"color": "#4682B4", "id": "Introduction to Unix", "label": "Introduction to Unix", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Unix\nCourse Pre-reqs: None\nSubsequent Courses: Introduction to HPC, Introduction to Version Control with Git and GitHub"}, {"color": "#4682B4", "id": "Introduction to Version Control with Git and GitHub", "label": "Introduction to Version Control with Git and GitHub", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Version Control with Git and GitHub\nCourse Pre-reqs: Introduction to Unix\nSubsequent Courses: Intermediate Version Control"}, {"color": "#4682B4", "id": "Intermediate Version Control", "label": "Intermediate Version Control", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Intermediate Version Control\nCourse Pre-reqs: Introduction to Version Control with Git and GitHub\nSubsequent Courses: None"}, {"color": "#4682B4", "id": "Introduction to Python", "label": "Introduction to Python", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Python\nCourse Pre-reqs: None\nSubsequent Courses: None"}]);
286286
edges = new vis.DataSet([{"arrows": "to", "from": "Introduction to HPC", "to": "Parallel Computing", "width": 1}, {"arrows": "to", "from": "Introduction to Unix", "to": "Introduction to HPC", "width": 1}, {"arrows": "to", "from": "Introduction to Unix", "to": "Introduction to Version Control with Git and GitHub", "width": 1}, {"arrows": "to", "from": "Introduction to Version Control with Git and GitHub", "to": "Intermediate Version Control", "width": 1}]);
287287

288288
nodeColors = {};

_static/workshops_network_python_ds.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,8 +282,8 @@ <h1></h1>
282282

283283

284284
// parsing and collecting nodes and edges from the python
285-
nodes = new vis.DataSet([{"color": "#4682B4", "id": "Introduction to Version Control with Git and GitHub", "label": "Introduction to Version Control with Git and GitHub", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Version Control with Git and GitHub\nCourse Pre-reqs: Introduction to Unix\nSubsequent Courses: Intermediate Version Control"}, {"color": "#4682B4", "id": "Intermediate Version Control", "label": "Intermediate Version Control", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Intermediate Version Control\nCourse Pre-reqs: Introduction to Version Control with Git and GitHub\nSubsequent Courses: None"}, {"color": "#4682B4", "id": "Introduction to Unix", "label": "Introduction to Unix", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Unix\nCourse Pre-reqs: None\nSubsequent Courses: Introduction to Version Control with Git and GitHub"}, {"color": "#4682B4", "id": "Introduction to Python", "label": "Introduction to Python", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Python\nCourse Pre-reqs: None\nSubsequent Courses: Python for Data Analysis "}, {"color": "#4682B4", "id": "Python for Data Analysis ", "label": "Python for Data Analysis ", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Python for Data Analysis \nCourse Pre-reqs: Introduction to Python\nSubsequent Courses: None"}]);
286-
edges = new vis.DataSet([{"arrows": "to", "from": "Introduction to Version Control with Git and GitHub", "to": "Intermediate Version Control", "width": 1}, {"arrows": "to", "from": "Introduction to Unix", "to": "Introduction to Version Control with Git and GitHub", "width": 1}, {"arrows": "to", "from": "Introduction to Python", "to": "Python for Data Analysis ", "width": 1}]);
285+
nodes = new vis.DataSet([{"color": "#FFD700", "id": "Introduction to Version Control with Git and GitHub", "label": "Introduction to Version Control with Git and GitHub", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Version Control with Git and GitHub\nCourse Pre-reqs: Introduction to Unix\nSubsequent Courses: Intermediate Version Control"}, {"color": "#FFD700", "id": "Intermediate Version Control", "label": "Intermediate Version Control", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Intermediate Version Control\nCourse Pre-reqs: Introduction to Version Control with Git and GitHub\nSubsequent Courses: None"}, {"color": "#FFD700", "id": "Introduction to Unix", "label": "Introduction to Unix", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Unix\nCourse Pre-reqs: None\nSubsequent Courses: Introduction to Version Control with Git and GitHub"}, {"color": "#FFD700", "id": "Introduction to Python", "label": "Introduction to Python", "level": 1, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Python\nCourse Pre-reqs: None\nSubsequent Courses: Python for Data Analysis"}, {"color": "#FFD700", "id": "Python for Data Analysis", "label": "Python for Data Analysis", "level": 2, "shape": "dot", "size": 10, "title": "Course Name: Python for Data Analysis\nCourse Pre-reqs: Introduction to Python\nSubsequent Courses: Introduction to Machine Learning"}, {"color": "#FFD700", "id": "Introduction to Machine Learning", "label": "Introduction to Machine Learning", "level": 3, "shape": "dot", "size": 10, "title": "Course Name: Introduction to Machine Learning\nCourse Pre-reqs: Python for Data Analysis\nSubsequent Courses: None"}]);
286+
edges = new vis.DataSet([{"arrows": "to", "from": "Introduction to Version Control with Git and GitHub", "to": "Intermediate Version Control", "width": 1}, {"arrows": "to", "from": "Introduction to Unix", "to": "Introduction to Version Control with Git and GitHub", "width": 1}, {"arrows": "to", "from": "Introduction to Python", "to": "Python for Data Analysis", "width": 1}, {"arrows": "to", "from": "Python for Data Analysis", "to": "Introduction to Machine Learning", "width": 1}]);
287287

288288
nodeColors = {};
289289
allNodes = nodes.get({ returnType: "Object" });

_toc.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -196,15 +196,14 @@ parts:
196196
- file: individual_modules/improve_your_r_code/rcpp
197197
- file: individual_modules/section_landing_pages/Introduction_to_Markdown_in_R
198198
sections:
199-
- file: individual_modules/Introduction_to_Markdown_in_R/1_Course_Overview
200-
- file: individual_modules/Introduction_to_Markdown_in_R/2_Background_to_Markdown
201-
- file: individual_modules/Introduction_to_Markdown_in_R/3_Getting_Started_with_Markdown_in_R
202-
- file: individual_modules/Introduction_to_Markdown_in_R/4a_RMarkdown_Components_Visual_Prelude
203-
- file: individual_modules/Introduction_to_Markdown_in_R/4b_RMarkdown_Components_YAML_Header
204-
- file: individual_modules/Introduction_to_Markdown_in_R/4c_RMarkdown_Components_Formatted_Text
205-
- file: individual_modules/Introduction_to_Markdown_in_R/4d_RMarkdown_Components_Embedded_Code
206-
- file: individual_modules/Introduction_to_Markdown_in_R/5_Processing_RMarkdown_Files
207-
- file: individual_modules/Introduction_to_Markdown_in_R/6_Course_Outro
199+
- file: individual_modules/Introduction_to_Markdown_in_R/Background_to_Markdown
200+
- file: individual_modules/Introduction_to_Markdown_in_R/Getting_Started_with_Markdown_in_R
201+
- file: individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_Visual_Prelude
202+
- file: individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_YAML_Header
203+
- file: individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_Formatted_Text
204+
- file: individual_modules/Introduction_to_Markdown_in_R/RMarkdown_Components_Embedded_Code
205+
- file: individual_modules/Introduction_to_Markdown_in_R/Processing_RMarkdown_Files
206+
- file: individual_modules/Introduction_to_Markdown_in_R/Course_Outro
208207
- file: course_homepages/unix
209208
sections:
210209
- file: individual_modules/section_landing_pages/introduction_to_unix

individual_modules/Introduction_to_Markdown_in_R/1_Course_Overview.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

individual_modules/Introduction_to_Markdown_in_R/2_Background_to_Markdown.md renamed to individual_modules/Introduction_to_Markdown_in_R/Background_to_Markdown.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# Introduction to Markdown in R
1+
# A general background to Markdown
22

3-
## A general background to Markdown
4-
5-
### What is Markdown?
3+
## What is Markdown?
64

75
Markdown is a special type of language that can be used to create formatted text within a text editor. The concept of Markdown was created by John Gruber in 2004. Unlike programming languages which execute commands, Markdown is used to define the appearance and structure of text. It has a dedicated set of annotation sytnax (e.g. symbols) that can be used to control the formatting of text, from defining headers and boldening words, to adding hyperlinks and creating lists. While the annotation syntax is visible in the Markdown document itself, it does not actually show up in the outputted version of the document. Instead, the annotation syntax gets processed as instructions that dictate how the output content is displayed.
86

9-
### Why use Markdown?
7+
## Why use Markdown?
108

119
Markdown offers several broad advantages, such as:
1210

individual_modules/Introduction_to_Markdown_in_R/6_Course_Outro.md renamed to individual_modules/Introduction_to_Markdown_in_R/Course_Outro.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
# Introduction to Markdown in R
1+
# Summary
22

3-
## Outro
4-
5-
### Final take-homes
3+
## Final take-homes
64

75
- The Markdown language is a useful tool for altering the format and structure of plain text
86
- Markdown is best implemented in R *via* RStudio using the `rmarkdown` R package
97
- R Markdown documents permit dynamic integration of formatted plain text, R code and its outputs, in turn supporting reproducible software development, data analysis and workflows
108

11-
### Acknowledgements and additional resources
9+
## Acknowledgements and additional resources
1210

1311
This workshop shares some thoughts and ideas from the following resources:
1412

1513
- The [Reproducible Research in R](https://monashdatafluency.github.io/r-rep-res/index.html) course developed for the Monash Bioinformatics Platform
1614
- The [R Markdown Cookbook](https://bookdown.org/yihui/rmarkdown-cookbook/) developed by Yihui Xie, Christophe Dervieux and Emily Riederer
17-
- The [Introduction to Markdown in Python]() workshop offered by University of Exeter's Coding for Reproducable Research programme
15+
- The [Introduction to Markdown in Python](../../programme_information/python.ipynb) workshop offered by University of Exeter's Coding for Reproducable Research programme
1816
- The [R Markdown "cheat sheet"](https://posit.co/wp-content/uploads/2022/10/rmarkdown-1.pdf) available through [posit](https://posit.co/).
1917

2018
Creation of this workshop was also supported by [ChatGPT](https://openai.com/index/chatgpt/).
2119

22-
### Bonus task
20+
## Bonus task
2321

2422
Below are links to some tutorials from the `microbiome` R package for analysis of microbiome data (Bioconductor landing page [here](https://www.bioconductor.org/packages/release/bioc/html/microbiome.html)):
2523

individual_modules/Introduction_to_Markdown_in_R/3_Getting_Started_with_Markdown_in_R.md renamed to individual_modules/Introduction_to_Markdown_in_R/Getting_Started_with_Markdown_in_R.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Introduction to Markdown in R
1+
# Getting Started
22

3-
## Getting started with Markdown in R
4-
5-
### What are the benefits of using Markdown in R?
3+
## What are the benefits of using Markdown in R?
64

75
Implementing Markdown in R provides many benefits, for example:
86

@@ -13,11 +11,11 @@ Implementing Markdown in R provides many benefits, for example:
1311
|Felixble outputs| Through implementation of Markdown in R, your R code and plain text can be integrated together in a variety of different output formats, from interactive HTML reports that can be viewed in a browser, to print-friendly PDF files, editable Microsoft Word documents and even Microsoft Powerpoint Presentation format. As such, you have the flexibility to be able to present and share your R code in a way that you most prefer or that is best suited to the context at hand. |
1412
|Multiple languages| While the most logical implementation of Markdown in R is to produce dynamic documents of R code alongside formatted text, it is also possible to integrate and run other programming languages through Markdown in R, such a Python. This can be very useful in cases where you might need to leverage functions or libraries in the same pipeline that are native to different coding languages. |
1513

16-
### How is Markdown implemented in R?
14+
## How is Markdown implemented in R?
1715

1816
Markdown is predominantly implemented in R *via* RStudio using a dedicated R package called `rmarkdown`.
1917

20-
#### Installing the `rmarkdown` package:
18+
### Installing the `rmarkdown` package:
2119

2220
The `rmarkdown` package is available for download and installation through the Comprehensive R Archive Network (CRAN). This process can be undertaken by first opening RStudio and then performing the following click-button steps:
2321

@@ -35,7 +33,7 @@ Alternitively, after opening RStudio, `rmarkdown` can be downloaded and installe
3533
install.packages('rmarkdown')
3634
```
3735

38-
#### Creating a new R Markdown document:
36+
### Creating a new R Markdown document:
3937

4038
Once the `rmarkdown` package has been installed, a new, blank R Markdown document can be created in RStudio by:
4139

@@ -47,6 +45,6 @@ Once the `rmarkdown` package has been installed, a new, blank R Markdown documen
4745
Completing the above four steps should result in an RStudio window that looks like the following:
4846
![Blank RMarkdown file](Embedded_Display_Items/Blank_RMarkdown_View.png)
4947

50-
#### Saving a (new) R Markdown document:
48+
### Saving a (new) R Markdown document:
5149

5250
After initialising a new R Markdown document, it can be saved by clicking `File` at the top of the screen and selecting `Save`. Alternatively, the save process can be performed by clicking the <img src = "Embedded_Display_Items/floppy_disk.png" alt = "floppy disk" width = "25" style = "vertical-align:middle;"> button. It is also good practice to repeat the save process regularly when putting together an R Markdown document so that no progress is lost.

0 commit comments

Comments
 (0)