Skip to content

Commit 3b57488

Browse files
liamjberrisfordliamjberrisford
committed
Website plumbing and required pages
1 parent eda2f44 commit 3b57488

File tree

4 files changed

+261
-0
lines changed

4 files changed

+261
-0
lines changed

‎_toc.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ parts:
3232
- file: programme_information/advanced_regression_analysis_with_r
3333
- file: programme_information/working_with_data_in_r
3434
- file: programme_information/improve_your_r_code
35+
- file: programme_information/Introduction_to_Markdown_in_R
3536
- file: programme_information/unix
3637
sections:
3738
- file: programme_information/intro_to_unix
@@ -193,6 +194,17 @@ parts:
193194
- file: individual_modules/improve_your_r_code/data_table
194195
- file: individual_modules/improve_your_r_code/parallelisation
195196
- file: individual_modules/improve_your_r_code/rcpp
197+
- file: individual_modules/section_landing_pages/Introduction_to_Markdown_in_R
198+
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
196208
- file: course_homepages/unix
197209
sections:
198210
- file: individual_modules/section_landing_pages/introduction_to_unix

‎individual_modules/Introduction_to_Markdown_in_R/LICENSE.txt

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
2+
### Instructional Material
3+
4+
The instructional material in this course is copyright © 2025 University of Exeter
5+
and is made available under the Creative Commons Attribution 4.0 International
6+
licence (https://creativecommons.org/licenses/by/4.0/). Instructional material
7+
consists of material that is contained within the "individual_modules/Introduction_to_Markdown_in_R" directory, and images folders in
8+
this directory, with the exception of code snippets and example programs found
9+
in files within these folders. Such code snippets and example programs are
10+
considered software for the purposes of this licence.
11+
12+
13+
### Software
14+
15+
Except where otherwise noted, software provided in this repository is made
16+
available under the MIT licence (https://opensource.org/licenses/MIT).
17+
18+
Copyright © 2025 University of Exeter
19+
20+
Permission is hereby granted, free of charge, to any person obtaining a copy
21+
of this software and associated documentation files (the "Software"), to deal
22+
in the Software without restriction, including without limitation the rights
23+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
24+
copies of the Software, and to permit persons to whom the Software is
25+
furnished to do so, subject to the following conditions:
26+
27+
The above copyright notice and this permission notice shall be included in all
28+
copies or substantial portions of the Software.
29+
30+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
33+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
34+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
35+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36+
SOFTWARE.
37+
38+
The software in this repository is adapted from software that is covered by the
39+
following copyright and permission notice:
40+
41+
Copyright © 2025 Software Carpentry
42+
43+
Permission is hereby granted, free of charge, to any person obtaining
44+
a copy of this software and associated documentation files (the
45+
"Software"), to deal in the Software without restriction, including
46+
without limitation the rights to use, copy, modify, merge, publish,
47+
distribute, sublicense, and/or sell copies of the Software, and to
48+
permit persons to whom the Software is furnished to do so, subject to
49+
the following conditions:
50+
51+
The above copyright notice and this permission notice shall be
52+
included in all copies or substantial portions of the Software.
53+
54+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
55+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
56+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
57+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
58+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
59+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
60+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎individual_modules/section_landing_pages/Introduction_to_Markdown_in_R.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Introduction to Markdown in R

‎programme_information/Introduction_to_Markdown_in_R.ipynb

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"id": "186515a5-d388-4a72-bf07-722cc032835d",
6+
"metadata": {
7+
"editable": true,
8+
"slideshow": {
9+
"slide_type": ""
10+
},
11+
"tags": [
12+
"remove-input"
13+
]
14+
},
15+
"source": [
16+
"# Introduction to Markdown in R\n",
17+
"\n",
18+
"## Course description \n",
19+
"\n",
20+
"## Course objectives\n",
21+
"\n",
22+
"## Pre-requisite knowledge\n",
23+
"\n",
24+
"\n",
25+
"## Sign-up \n",
26+
"\n",
27+
"To check for upcoming course dates and to register, please visit the Workshop Schedule and Sign-up page available [here](../cfrr_program_details/courses_overview.ipynb)."
28+
]
29+
},
30+
{
31+
"cell_type": "markdown",
32+
"id": "a6896c46-1cf9-474c-a37f-2e5564c69d56",
33+
"metadata": {
34+
"editable": true,
35+
"slideshow": {
36+
"slide_type": ""
37+
},
38+
"tags": []
39+
},
40+
"source": [
41+
"## Installation guide\n",
42+
"\n",
43+
"## Self study materials \n",
44+
"\n",
45+
"This course will be delivered via a mixture of slides and programming tutorials. All materials for this course can be found and downloaded from the course landing page [here](../individual_modules/section_landing_pages/Introduction_to_Markdown_in_R.md).\n",
46+
"\n",
47+
"## Developers\n",
48+
"\n",
49+
"The developer of this course is\n",
50+
"\n",
51+
"## License info"
52+
]
53+
},
54+
{
55+
"cell_type": "code",
56+
"execution_count": 3,
57+
"id": "504820cb-aa9b-4579-92ec-0fb518244f25",
58+
"metadata": {
59+
"editable": true,
60+
"slideshow": {
61+
"slide_type": ""
62+
},
63+
"tags": [
64+
"remove-input"
65+
]
66+
},
67+
"outputs": [
68+
{
69+
"data": {
70+
"text/markdown": [
71+
"\n",
72+
"### Instructional Material\n",
73+
"\n",
74+
"The instructional material in this course is copyright © 2025 University of Exeter\n",
75+
"and is made available under the Creative Commons Attribution 4.0 International\n",
76+
"licence (https://creativecommons.org/licenses/by/4.0/). Instructional material\n",
77+
"consists of material that is contained within the \"individual_modules/Introduction_to_Markdown_in_R\" directory, and images folders in\n",
78+
"this directory, with the exception of code snippets and example programs found\n",
79+
"in files within these folders. Such code snippets and example programs are\n",
80+
"considered software for the purposes of this licence. \n",
81+
"\n",
82+
"\n",
83+
"### Software\n",
84+
"\n",
85+
"Except where otherwise noted, software provided in this repository is made\n",
86+
"available under the MIT licence (https://opensource.org/licenses/MIT).\n",
87+
"\n",
88+
"Copyright © 2025 University of Exeter\n",
89+
"\n",
90+
"Permission is hereby granted, free of charge, to any person obtaining a copy\n",
91+
"of this software and associated documentation files (the \"Software\"), to deal\n",
92+
"in the Software without restriction, including without limitation the rights\n",
93+
"to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n",
94+
"copies of the Software, and to permit persons to whom the Software is\n",
95+
"furnished to do so, subject to the following conditions:\n",
96+
"\n",
97+
"The above copyright notice and this permission notice shall be included in all\n",
98+
"copies or substantial portions of the Software.\n",
99+
"\n",
100+
"THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n",
101+
"IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n",
102+
"FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n",
103+
"AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n",
104+
"LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n",
105+
"OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n",
106+
"SOFTWARE.\n",
107+
"\n",
108+
"The software in this repository is adapted from software that is covered by the\n",
109+
"following copyright and permission notice:\n",
110+
"\n",
111+
" Copyright © 2025 Software Carpentry\n",
112+
"\n",
113+
" Permission is hereby granted, free of charge, to any person obtaining\n",
114+
" a copy of this software and associated documentation files (the\n",
115+
" \"Software\"), to deal in the Software without restriction, including\n",
116+
" without limitation the rights to use, copy, modify, merge, publish,\n",
117+
" distribute, sublicense, and/or sell copies of the Software, and to\n",
118+
" permit persons to whom the Software is furnished to do so, subject to\n",
119+
" the following conditions:\n",
120+
"\n",
121+
" The above copyright notice and this permission notice shall be\n",
122+
" included in all copies or substantial portions of the Software.\n",
123+
"\n",
124+
" THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n",
125+
" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n",
126+
" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n",
127+
" NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n",
128+
" LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n",
129+
" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n",
130+
" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
131+
],
132+
"text/plain": [
133+
"<IPython.core.display.Markdown object>"
134+
]
135+
},
136+
"metadata": {},
137+
"output_type": "display_data"
138+
}
139+
],
140+
"source": [
141+
"from IPython.display import Markdown, display\n",
142+
"\n",
143+
"def display_markdown(file_path):\n",
144+
" try:\n",
145+
" with open(file_path, 'r') as file:\n",
146+
" content = file.read()\n",
147+
" display(Markdown(content))\n",
148+
" except FileNotFoundError:\n",
149+
" print(f\"The file {file_path} was not found.\")\n",
150+
" except Exception as e:\n",
151+
" print(f\"An error occurred: {e}\")\n",
152+
"\n",
153+
"# Example usage:\n",
154+
"file_path = '../individual_modules/Introduction_to_Markdown_in_R/LICENSE.txt'\n",
155+
"display_markdown(file_path)"
156+
]
157+
},
158+
{
159+
"cell_type": "code",
160+
"execution_count": null,
161+
"id": "f1ce6bcf-1177-4c9c-a210-dd9f5ca5b58f",
162+
"metadata": {},
163+
"outputs": [],
164+
"source": []
165+
}
166+
],
167+
"metadata": {
168+
"kernelspec": {
169+
"display_name": "Python 3 (ipykernel)",
170+
"language": "python",
171+
"name": "python3"
172+
},
173+
"language_info": {
174+
"codemirror_mode": {
175+
"name": "ipython",
176+
"version": 3
177+
},
178+
"file_extension": ".py",
179+
"mimetype": "text/x-python",
180+
"name": "python",
181+
"nbconvert_exporter": "python",
182+
"pygments_lexer": "ipython3",
183+
"version": "3.9.19"
184+
}
185+
},
186+
"nbformat": 4,
187+
"nbformat_minor": 5
188+
}

0 commit comments

Comments
 (0)