Skip to content

Commit 3a85d38

Browse files
actions-useractions-user
committed
source commit: 5dda5b7 
0 parents  commit 3a85d38

19 files changed

+2403
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Contributor Code of Conduct"
3+
---
4+
5+
As contributors and maintainers of this project,
6+
we pledge to follow the [The Carpentries Code of Conduct][coc].
7+
8+
Instances of abusive, harassing, or otherwise unacceptable behavior
9+
may be reported by following our [reporting guidelines][coc-reporting].
10+
11+
12+
[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
13+
[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html

‎LICENSE.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: "Licenses"
3+
---
4+
5+
## Instructional Material
6+
7+
All Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry)
8+
instructional material is made available under the [Creative Commons
9+
Attribution license][cc-by-human]. The following is a human-readable summary of
10+
(and not a substitute for) the [full legal text of the CC BY 4.0
11+
license][cc-by-legal].
12+
13+
You are free:
14+
15+
- to **Share**---copy and redistribute the material in any medium or format
16+
- to **Adapt**---remix, transform, and build upon the material
17+
18+
for any purpose, even commercially.
19+
20+
The licensor cannot revoke these freedoms as long as you follow the license
21+
terms.
22+
23+
Under the following terms:
24+
25+
- **Attribution**---You must give appropriate credit (mentioning that your work
26+
is derived from work that is Copyright (c) The Carpentries and, where
27+
practical, linking to <https://carpentries.org/>), provide a [link to the
28+
license][cc-by-human], and indicate if changes were made. You may do so in
29+
any reasonable manner, but not in any way that suggests the licensor endorses
30+
you or your use.
31+
32+
- **No additional restrictions**---You may not apply legal terms or
33+
technological measures that legally restrict others from doing anything the
34+
license permits. With the understanding that:
35+
36+
Notices:
37+
38+
* You do not have to comply with the license for elements of the material in
39+
the public domain or where your use is permitted by an applicable exception
40+
or limitation.
41+
* No warranties are given. The license may not give you all of the permissions
42+
necessary for your intended use. For example, other rights such as publicity,
43+
privacy, or moral rights may limit how you use the material.
44+
45+
## Software
46+
47+
Except where otherwise noted, the example programs and other software provided
48+
by The Carpentries are made available under the [OSI][osi]-approved [MIT
49+
license][mit-license].
50+
51+
Permission is hereby granted, free of charge, to any person obtaining a copy of
52+
this software and associated documentation files (the "Software"), to deal in
53+
the Software without restriction, including without limitation the rights to
54+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
55+
of the Software, and to permit persons to whom the Software is furnished to do
56+
so, subject to the following conditions:
57+
58+
The above copyright notice and this permission notice shall be included in all
59+
copies or substantial portions of the Software.
60+
61+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
62+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
63+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
64+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
65+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
66+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
67+
SOFTWARE.
68+
69+
## Trademark
70+
71+
"The Carpentries", "Software Carpentry", "Data Carpentry", and "Library
72+
Carpentry" and their respective logos are registered trademarks of [Community
73+
Initiatives][ci].
74+
75+
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
76+
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
77+
[mit-license]: https://opensource.org/licenses/mit-license.html
78+
[ci]: https://communityin.org/
79+
[osi]: https://opensource.org

‎Syncing your project with GitLab

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
2+
---
3+
title: "Using RMarkdown"
4+
teaching: 10
5+
exercises: 2
6+
---
7+
8+
:::::::::::::::::::::::::::::::::::::: questions
9+
10+
- How do you write a lesson using R Markdown and `{sandpaper}`?
11+
12+
::::::::::::::::::::::::::::::::::::::::::::::::
13+
14+
::::::::::::::::::::::::::::::::::::: objectives
15+
16+
- Explain how to use markdown with the new lesson template
17+
- Demonstrate how to include pieces of code, figures, and nested challenge blocks
18+
19+
::::::::::::::::::::::::::::::::::::::::::::::::
20+
21+
## Introduction
22+
23+
This is a lesson created via The Carpentries Workbench. It is written in
24+
[Pandoc-flavored Markdown](https://pandoc.org/MANUAL.txt) for static files and
25+
[R Markdown][r-markdown] for dynamic files that can render code into output.
26+
Please refer to the [Introduction to The Carpentries
27+
Workbench](https://carpentries.github.io/sandpaper-docs/) for full documentation.
28+
29+
What you need to know is that there are three sections required for a valid
30+
Carpentries lesson template:
31+
32+
1. `questions` are displayed at the beginning of the episode to prime the
33+
learner for the content.
34+
2. `objectives` are the learning objectives for an episode displayed with
35+
the questions.
36+
3. `keypoints` are displayed at the end of the episode to reinforce the
37+
objectives.
38+
39+
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor
40+
41+
Inline instructor notes can help inform instructors of timing challenges
42+
associated with the lessons. They appear in the "Instructor View"
43+
44+
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
45+
46+
::::::::::::::::::::::::::::::::::::: challenge
47+
48+
## Challenge 1: Can you do it?
49+
50+
What is the output of this command?
51+
52+
```r
53+
paste("This", "new", "lesson", "looks", "good")
54+
```
55+
56+
:::::::::::::::::::::::: solution
57+
58+
## Output
59+
60+
```output
61+
[1] "This new lesson looks good"
62+
```
63+
64+
:::::::::::::::::::::::::::::::::
65+
66+
67+
## Challenge 2: how do you nest solutions within challenge blocks?
68+
69+
:::::::::::::::::::::::: solution
70+
71+
You can add a line with at least three colons and a `solution` tag.
72+
73+
:::::::::::::::::::::::::::::::::
74+
::::::::::::::::::::::::::::::::::::::::::::::::
75+
76+
## Figures
77+
78+
You can also include figures generated from R Markdown:
79+
80+
```{r pyramid, fig.alt = "pie chart illusion of a pyramid", fig.cap = "Sun arise each and every morning"}
81+
pie(
82+
c(Sky = 78, "Sunny side of pyramid" = 17, "Shady side of pyramid" = 5),
83+
init.angle = 315,
84+
col = c("deepskyblue", "yellow", "yellow3"),
85+
border = FALSE
86+
)
87+
```
88+
89+
Or you can use standard markdown for static figures with the following syntax:
90+
91+
`![optional caption that appears below the figure](figure url){alt='alt text for
92+
accessibility purposes'}`
93+
94+
![You belong in The Carpentries!](https://raw.githubusercontent.com/carpentries/logo/master/Badge_Carpentries.svg){alt='Blue Carpentries hex person logo with no text.'}
95+
96+
::::::::::::::::::::::::::::::::::::: callout
97+
98+
Callout sections can highlight information.
99+
100+
They are sometimes used to emphasise particularly important points
101+
but are also used in some lessons to present "asides":
102+
content that is not central to the narrative of the lesson,
103+
e.g. by providing the answer to a commonly-asked question.
104+
105+
::::::::::::::::::::::::::::::::::::::::::::::::
106+
107+
108+
## Math
109+
110+
One of our episodes contains $\LaTeX$ equations when describing how to create
111+
dynamic reports with {knitr}, so we now use mathjax to describe this:
112+
113+
`$\alpha = \dfrac{1}{(1 - \beta)^2}$` becomes: $\alpha = \dfrac{1}{(1 - \beta)^2}$
114+
115+
Cool, right?
116+
117+
::::::::::::::::::::::::::::::::::::: keypoints
118+
119+
- Use `.md` files for episodes when you want static content
120+
- Use `.Rmd` files for episodes when you need to generate output
121+
- Run `sandpaper::check_lesson()` to identify any issues with your lesson
122+
- Run `sandpaper::build_lesson()` to preview your lesson locally
123+
124+
::::::::::::::::::::::::::::::::::::::::::::::::
125+
126+
[r-markdown]: https://rmarkdown.rstudio.com/

‎config.yaml

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
#------------------------------------------------------------
2+
# Values for this lesson.
3+
#------------------------------------------------------------
4+
5+
# Which carpentry is this (swc, dc, lc, or cp)?
6+
# swc: Software Carpentry
7+
# dc: Data Carpentry
8+
# lc: Library Carpentry
9+
# cp: Carpentries (to use for instructor training for instance)
10+
# incubator: The Carpentries Incubator
11+
#
12+
# This option supports custom types so lessons can be branded
13+
# and themed with your own logo and alt-text (see `carpentry_description`)
14+
# See https://carpentries.github.io/sandpaper-docs/editing.html#adding-a-custom-logo
15+
carpentry: 'incubator'
16+
17+
# Alt-text description of the lesson.
18+
carpentry_description: 'Lesson Description'
19+
20+
# Overall title for pages.
21+
title: 'Organizing Your Projects with GitLab and RStudio' # FIXME
22+
23+
# Date the lesson was created (YYYY-MM-DD, this is empty by default)
24+
created: 2024-12-09 # FIXME: ( ~ means empty, replace with date formatted as above)
25+
26+
# Comma-separated list of keywords for the lesson
27+
keywords: 'software, data, lesson, The Carpentries' # FIXME
28+
29+
# Life cycle stage of the lesson
30+
# possible values: pre-alpha, alpha, beta, stable
31+
life_cycle: 'pre-alpha' # FIXME
32+
33+
# License of the lesson
34+
license: 'CC-BY 4.0'
35+
36+
# Link to the source repository for this lesson
37+
source: 'https://github.com/UW-Madison-DataScience/R-gitlab-lesson' # FIXME
38+
39+
# Default branch of your lesson
40+
branch: 'main'
41+
42+
# Who to contact if there are any issues
43+
contact: '[email protected]' # FIXME
44+
45+
# Navigation ------------------------------------------------
46+
#
47+
# Use the following menu items to specify the order of
48+
# individual pages in each dropdown section. Leave blank to
49+
# include all pages in the folder.
50+
#
51+
# Example -------------
52+
#
53+
# episodes:
54+
# - introduction.md
55+
# - first-steps.md
56+
#
57+
# learners:
58+
# - setup.md
59+
#
60+
# instructors:
61+
# - instructor-notes.md
62+
#
63+
# profiles:
64+
# - one-learner.md
65+
# - another-learner.md
66+
67+
# Order of episodes in your lesson
68+
episodes:
69+
- intro.Rmd
70+
- git.Rmd
71+
- gitlab.Rmd
72+
73+
# Information for Learners
74+
learners:
75+
76+
# Information for Instructors
77+
instructors:
78+
79+
# Learner Profiles
80+
profiles:
81+
82+
# Customisation ---------------------------------------------
83+
#
84+
# This space below is where custom yaml items (e.g. pinning
85+
# sandpaper and varnish versions) should live
86+
87+

0 commit comments

Comments
 (0)