Skip to content

Commit 516f495

Browse files
jonthegeekjonthegeek
authored
Initial commit
0 parents  commit 516f495

17 files changed

+367
-0
lines changed

‎.Rbuildignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
^.*\.Rproj$
2+
^\.Rproj\.user$
3+
^\.github$

‎.github/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [email protected].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
125+
126+
[homepage]: https://www.contributor-covenant.org

‎.github/workflows/deploy_bookdown.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
on:
2+
push:
3+
branches: main
4+
paths-ignore:
5+
- 'README.md'
6+
workflow_dispatch:
7+
8+
jobs:
9+
bookdown:
10+
uses: r4ds/r4dsactions/.github/workflows/render_pages.yml@main

‎.github/workflows/pr_check.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
on:
2+
pull_request:
3+
branches: main
4+
paths-ignore:
5+
- 'README.md'
6+
workflow_dispatch:
7+
8+
jobs:
9+
pr_check:
10+
uses: r4ds/r4dsactions/.github/workflows/render_check.yml@main

‎.github/workflows/pr_check_readme.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
on:
2+
pull_request:
3+
branches: main
4+
paths:
5+
- 'README.md'
6+
workflow_dispatch:
7+
8+
jobs:
9+
pr_check:
10+
uses: r4ds/r4dsactions/.github/workflows/render_check_readme.yml@main

‎.gitignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.Rproj.user
2+
.Rhistory
3+
.Rdata
4+
.httr-oauth
5+
.DS_Store
6+
_book
7+
_bookdown_files
8+
bookclub-{{{book_abbr}}}.Rmd
9+
bookclub-{{{book_abbr}}}.knit.md
10+
bookclub-{{{book_abbr}}}_files
11+
libs
12+
*.html

‎99999.Rmd‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# {{{chapter_title}}}
2+
3+
**Learning objectives:**
4+
5+
- THESE ARE NICE TO HAVE BUT NOT ABSOLUTELY NECESSARY
6+
7+
## SLIDE 1 {-}
8+
9+
- ADD SLIDES AS SECTIONS (`##`).
10+
- TRY TO KEEP THEM RELATIVELY SLIDE-LIKE; THESE ARE NOTES, NOT THE BOOK ITSELF.
11+
12+
## Meeting Videos {-}
13+
14+
### Cohort 1 {-}
15+
16+
`r knitr::include_url("https://www.youtube.com/embed/URL")`
17+
18+
<details>
19+
<summary> Meeting chat log </summary>
20+
21+
```
22+
LOG
23+
```
24+
</details>

‎DESCRIPTION‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Package: bookclub-{{{book_abbr}}}
2+
Title: {{{book_name}}} Book Club
3+
Version: 0.0.1
4+
Authors@R:
5+
person("Data Science Learning Community", , , "[email protected]", role = c("aut", "cre", "cph"))
6+
URL: https://r4ds.github.io/bookclub-{{{book_abbr}}},
7+
https://github.com/r4ds/bookclub-{{{book_abbr}}}
8+
Depends:
9+
R (>= 3.1.0)
10+
Imports:
11+
bookdown,
12+
rmarkdown
13+
Encoding: UTF-8

‎README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# DSLC {{{book_name}}} Book Club
2+
3+
Welcome to the DSLC {{{book_name}}} Book Club!
4+
5+
We are working together to read [_{{{book_name}}}_]({{{book_url}}}) by {{{book_authors}}} (copyright {{{book_copyright}}}).
6+
{{#print}}If you would like a print version, please consider purchasing it using our [Amazon Affiliates link]({{{print_url}}}). All profits from purchases through that link go toward maintaining the Data Science Learning Community.{{/print}}
7+
Join the [#book_club-{{{book_abbr}}}](https://dslcio.slack.com/archives/{{{book_channel_id}}}) channel on the [DSLC Slack](https://dslc.io/join) to participate.
8+
As we read, we are producing [notes about the book](https://dslc.io/{{{book_abbr}}}).
9+
10+
## Meeting Schedule
11+
12+
If you would like to present, please see the sign-up sheet for your cohort (linked below, and pinned in the [#book_club-{{{book_abbr}}}](https://dslcio.slack.com/archives/{{{book_channel_id}}}) channel on Slack)!
13+
14+
- [Cohort 1]({{{cohort01_signup_url}}}) (started {{{cohort01_start_date}}}, facilitated by {{{cohort01_facilitator_handle}}}): [{{{cohort01_day}}}, {{{cohort01_time_cst}}} CST/CDT]({{{cohort01_timeanddate_url}}}) | [meeting videos]({{{cohort01_youtube}}})
15+
16+
<hr>
17+
18+
19+
## How to Present
20+
21+
This repository is structured as a [{bookdown}](https://CRAN.R-project.org/package=bookdown) site.
22+
To present, follow these instructions:
23+
24+
Do these steps once:
25+
26+
1. [Setup Git and GitHub to work with RStudio](https://github.com/r4ds/bookclub-setup) (click through for detailed, step-by-step instructions; I recommend checking this out even if you're pretty sure you're all set).
27+
2. `usethis::create_from_github("r4ds/bookclub-{{{book_abbr}}}")` (cleanly creates your own copy of this repository).
28+
29+
Do these steps each time you present another chapter:
30+
31+
1. Open your project for this book.
32+
2. `usethis::pr_init("my-chapter")` (creates a branch for your work, to avoid confusion, making sure that you have the latest changes from other contributors; replace `my-chapter` with a descriptive name, ideally).
33+
3. `devtools::install_dev_deps()` (installs any packages used by the book that you don't already have installed).
34+
4. Edit the appropriate chapter file, if necessary. Use `##` to indicate new slides (new sections).
35+
5. If you use any packages that are not already in the `DESCRIPTION`, add them. You can use `usethis::use_package("myCoolPackage")` to add them quickly!
36+
6. Build the book! ctrl-shift-b (or command-shift-b) will render the full book, or ctrl-shift-k (command-shift-k) to render just your slide. Please do this to make sure it works before you push your changes up to the main repo!
37+
7. Commit your changes (either through the command line or using Rstudio's Git tab).
38+
8. `usethis::pr_push()` (pushes the changes up to github, and opens a "pull request" (PR) to let us know your work is ready).
39+
9. (If we request changes, make them)
40+
10. When your PR has been accepted ("merged"), `usethis::pr_finish()` to close out your branch and prepare your local repository for future work.
41+
11. Now that your local copy is up-to-date with the main repo, you need to update your remote fork. Run `gert::git_push("origin")` or click the `Push` button on the `Git` tab of Rstudio.
42+
43+
When your PR is checked into the main branch, the bookdown site will rebuild, adding your slides to [this site](https://dslc.io/{{{book_abbr}}}).
44+
45+
46+
## Code of Conduct
47+
48+
Please note that the bookclub-{{{book_abbr}}} project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

0 commit comments

Comments
 (0)