generated from carpentries/workbench-template-rmd
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37 from kaijagahm/xochitl_edits
Xochitl edits
- Loading branch information
Showing
2 changed files
with
27 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,29 @@ | ||
# RRRRRRRRR I'm stuck! | ||
# RRRRR... I'm stuck! | ||
|
||
This is a lesson for beginner R coders in data science to learn how to identify problems in code and solve them through the use of reproducible examples and community. | ||
This is a lesson for beginner R coders in data science to learn how to identify and resolve problematic code by using minimal reproducible examples to ask for help from the community. | ||
|
||
[**Link to Lesson Development Doc**](https://docs.google.com/document/d/1CkcEyFjr3u1JTos1w9lO0XYcgTJ9wRE6m6LhlwDh1dA/edit#heading=h.awmdspank0xf) | ||
The website for this lesson can be found at https://kaijagahm.github.io/R-help-reprexes/ | ||
|
||
[**Link to CodiMD**](https://codimd.carpentries.org/ElXZ2pJjTDGZsJjgvYs_Ig?both#Assessments%E2%80%93Notes-amp-discussion) | ||
This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. | ||
|
||
[**Etherpad for lesson alpha demo**](https://pad.carpentries.org/2024-08-12_reprex_alpha) | ||
## Lesson Developers: | ||
|
||
#### Primary Authors: | ||
[Kaija Gahm](https://github.com/kaijagahm) (kgahm [at] g.ucla.edu) | ||
[Xochitl Ortiz Ross](https://github.com/xortizross) (xortizross [at] g.ucla.edu) | ||
[Peter Laurin](https://github.com/peterlaurin) (peterlaurin [at] g.ucla.edu) | ||
|
||
- Kaija Gahm [kgahm [at] g.ucla.edu]([email protected]) | ||
- Xochitl Ortiz Ross [xortizross [at] g.ucla.edu]([email protected]) | ||
- Peter Laurin [peterlaurin [at] g.ucla.edu]([email protected]) | ||
|
||
This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. | ||
## The Data | ||
|
||
This lesson uses data from the `ratdat` package (CRAN page: https://cran.r-project.org/web/packages/ratdat/index.html). | ||
|
||
## Links related to the course development | ||
|
||
[**Link to Lesson Development Doc**](https://docs.google.com/document/d/1CkcEyFjr3u1JTos1w9lO0XYcgTJ9wRE6m6LhlwDh1dA/edit#heading=h.awmdspank0xf) | ||
|
||
[**Link to CodiMD**](https://codimd.carpentries.org/ElXZ2pJjTDGZsJjgvYs_Ig?both#Assessments%E2%80%93Notes-amp-discussion) | ||
|
||
[**Etherpad for lesson alpha demo**](https://pad.carpentries.org/2024-08-12_reprex_alpha) | ||
|
||
## Note about lesson life cycle stage | ||
Although the `config.yaml` states the life cycle stage as pre-alpha, **the template is stable and ready to use**. The life cycle stage is preset to `"pre-alpha"` as this setting is appropriate for new lessons initialised using the template. | ||
|
||
## Create a new repository from this template | ||
|
||
To use this template to start a new lesson repository, | ||
make sure you're logged into Github. | ||
Visit https://github.com/carpentries/workbench-template-rmd/generate | ||
and follow the instructions. | ||
Checking the 'Include all branches' option will save some time waiting for the first website build | ||
when your new repository is initialised. | ||
|
||
If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges) | ||
|
||
## Setup | ||
`CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files** | ||
as appropriate for your project. | ||
- `CODE_OF_CONDUCT.md`: | ||
if you are using this template for a project outside The Carpentries, | ||
you should adjust this file to describe | ||
who should be contacted with Code of Conduct reports, | ||
and how those reports will be handled. | ||
- `CONTRIBUTING.md`: | ||
depending on the current state and maturity of your project, | ||
the contents of the template Contributing Guide may not be appropriate. | ||
You should adjust the file to help guide contributors on how best | ||
to get involved and make an impact on your lesson. | ||
- `LICENSE.md`: | ||
in line with the terms of the CC-BY license, | ||
you should ensure that the copyright information | ||
provided in the license file is accurate for your project. | ||
|
||
[workbench]: https://carpentries.github.io/sandpaper-docs/ |