commit f6ceb800fbc9711e9148cf9e74f17e156bc41ed8
Author: Jon Harmon <jonthegeek@gmail.com>
Date: Sat, 14 May 2022 10:18:34 -0500
Initial commit
Diffstat:
14 files changed, 270 insertions(+), 0 deletions(-)
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -0,0 +1,2 @@
+^.*\.Rproj$
+^\.Rproj\.user$
diff --git a/.github/.gitignore b/.github/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/.github/workflows/deploy_bookdown.yml b/.github/workflows/deploy_bookdown.yml
@@ -0,0 +1,51 @@
+on:
+ push:
+ branches: main
+ workflow_dispatch:
+
+name: renderbook
+
+jobs:
+ bookdown:
+ name: Render-Book
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: r-lib/actions/setup-r@v2
+ with:
+ r-version: '4.2.0'
+ - uses: r-lib/actions/setup-pandoc@v2
+ - uses: r-lib/actions/setup-r-dependencies@v2
+ with:
+ cache-version: 2
+
+ - name: Render Book
+ run: Rscript -e 'bookdown::render_book("index.Rmd")'
+ - uses: actions/upload-artifact@v2
+ with:
+ name: _book
+ path: _book/
+
+# Need to first create an empty gh-pages branch
+# see https://pkgdown.r-lib.org/reference/deploy_site_github.html
+# and also add secrets for a GH_PAT and EMAIL to the repository
+# gh-action from Cecilapp/GitHub-Pages-deploy
+ checkout-and-deploy:
+ runs-on: ubuntu-latest
+ needs: bookdown
+ steps:
+ - name: Checkout
+ uses: actions/checkout@main
+ - name: Download artifact
+ uses: actions/download-artifact@v1.0.0
+ with:
+ # Artifact name
+ name: _book # optional
+ # Destination path
+ path: _book # optional
+ - name: Deploy to GitHub Pages
+ uses: Cecilapp/GitHub-Pages-deploy@v2
+ env:
+ EMAIL: ${{ secrets.EMAIL }} # must be a verified email
+ GH_TOKEN: ${{ secrets.GH_PAT }} # https://github.com/settings/tokens
+ BUILD_DIR: _book/ # "_site/" by default
diff --git a/.github/workflows/pr_check.yml b/.github/workflows/pr_check.yml
@@ -0,0 +1,22 @@
+on:
+ pull_request:
+ branches: main
+ workflow_dispatch:
+
+name: pr_check
+
+jobs:
+ bookdown:
+ name: pr_check_book
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: r-lib/actions/setup-r@v2
+ with:
+ r-version: '4.2.0'
+ - uses: r-lib/actions/setup-pandoc@v2
+ - uses: r-lib/actions/setup-r-dependencies@v2
+ with:
+ cache-version: 2
+ - name: Render Book
+ run: Rscript -e 'bookdown::render_book("index.Rmd")'
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,12 @@
+.Rproj.user
+.Rhistory
+.Rdata
+.httr-oauth
+.DS_Store
+_book
+_bookdown_files
+bookclub-BOOKABBR.Rmd
+bookclub-BOOKABBR.html
+bookclub-BOOKABBR.knit.md
+bookclub-BOOKABBR_files
+libs
diff --git a/01.Rmd b/01.Rmd
@@ -0,0 +1,24 @@
+# CHAPTER TITLE
+
+**Learning objectives:**
+
+- THESE ARE NICE TO HAVE BUT NOT ABSOLUTELY NECESSARY
+
+## SLIDE 1
+
+- ADD SLIDES AS SECTIONS (`##`).
+- TRY TO KEEP THEM RELATIVELY SLIDE-LIKE; THESE ARE NOTES, NOT THE BOOK ITSELF.
+
+## Meeting Videos
+
+### Cohort 1
+
+`r knitr::include_url("https://www.youtube.com/embed/URL")`
+
+<details>
+<summary> Meeting chat log </summary>
+
+```
+LOG
+```
+</details>
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -0,0 +1,17 @@
+Package: bookclub-BOOKABBR
+Title: BOOKNAME Book Club
+Version: 0.0.1
+Authors@R: c(
+ person(
+ "R4DS Online Learning Community",
+ email = "rfordatasci@gmail.com",
+ role = c("aut", "cre", "cph")
+ )
+ )
+URL: https://r4ds.github.io/bookclub-BOOKABBR, https://github.com/r4ds/bookclub-BOOKABBR
+Depends:
+ R (>= 3.1.0)
+Imports:
+ bookdown,
+ rmarkdown,
+ tidyverse
diff --git a/README.md b/README.md
@@ -0,0 +1,50 @@
+# R4DS BOOKNAME Book Club
+
+FIND/REPLACE BOOKABBR, BOOKNAME, BOOKURL, BOOKAUTHORS, BOOKPUBLISHER, BOOKCOPYRIGHT, BOOKISBN, BOOKDOI, BOOKDAYS, and BOOKTIMECST THEN DELETE THIS SENTENCE.
+
+ALSO UPDATE THE MEETING TIME INFO BELOW AND DELETE THIS SENTENCE.
+
+ALSO ADD PLACEHOLDERS FOR ALL CHAPTERS BY COPYING 01.Rmd (IDEALLY ALSO UPDATE TITLES WITHIN THE FILES), THEN DELETE THIS SENTENCE.
+
+Welcome to the R4DS BOOKNAME Book Club!
+
+We are working together to read [_BOOKNAME_](BOOKURL) by BOOKAUTHORS (BOOKPUBLISHER, copyright BOOKCOPYRIGHT, [BOOKISBN](BOOKDOI)).
+Join the #book_club-BOOKABBR channel on the [R4DS Slack](https://r4ds.io/join) to participate.
+As we read, we are producing [notes about the book](https://r4ds.io/BOOKABBR).
+
+## Meeting Schedule
+
+If you would like to present, please add your name next to a chapter using the [GitHub Web Editor](https://youtu.be/d41oc2OMAuI)!
+
+*Cohort 1: BOOKDAYS, BOOKTIMECST CST/CDT*
+
+<details>
+ <summary> Past Meetings </summary>
+
+(none yet)
+</details>
+
+- YYYY-MM-DD: Introduction - FACILITATOR
+- YYYY-MM-DD: Chapter 1 (TITLE) - Presenter TBD
+
+
+<hr>
+
+
+## How to Present
+
+This repository is structured as a [{bookdown}](https://CRAN.R-project.org/package=bookdown) site.
+To present, follow these instructions:
+
+1. [Setup Github Locally](https://www.youtube.com/watch?v=hNUNPkoledI)
+2. Fork this repository.
+3. Create a New Project in RStudio using your fork.
+4. Install dependencies for this book with `devtools::install_dev_deps()` (technically optional but it's nice to be able to rebuild the full book).
+5. Create a New Branch in your fork for your work.
+6. Edit the appropriate chapter file, if necessary. Use `##` to indicate new slides (new sections).
+7. 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!
+8. Commit your changes.
+9. Push your changes to your branch.
+10. Open a Pull Request (PR) to let us know that your slides are ready.
+
+When your PR is checked into the main branch, the bookdown site will rebuild, adding your slides to [this site](https://r4ds.io/BOOKABBR).
diff --git a/_bookdown.yml b/_bookdown.yml
@@ -0,0 +1,8 @@
+book_filename: "bookclub-BOOKABBR"
+repo: https://github.com/r4ds/bookclub-BOOKABBR
+edit: "https://github.com/r4ds/bookclub-BOOKABBR/edit/main/%s"
+output_dir: "_book"
+delete_merged_file: true
+language:
+ ui:
+ chapter_name: "Chapter "
diff --git a/_output.yml b/_output.yml
@@ -0,0 +1,17 @@
+bookdown::gitbook:
+ css: style.css
+ split_by: section
+ config:
+ toc:
+ collapse: section
+ before: |
+ <li><a href="./">BOOKNAME Book Club</a></li>
+ after: |
+ <li><a href="https://github.com/rstudio/bookdown" target="blank">Published with bookdown</a></li>
+ edit:
+ link: https://github.com/r4ds/bookclub-BOOKABBR/edit/main/%s
+ text: "Edit"
+ sharing:
+ github: yes
+ facebook: no
+ twitter: no
diff --git a/book.bib b/book.bib
@@ -0,0 +1,10 @@
+@Book{xie2015,
+ title = {Dynamic Documents with {R} and knitr},
+ author = {Yihui Xie},
+ publisher = {Chapman and Hall/CRC},
+ address = {Boca Raton, Florida},
+ year = {2015},
+ edition = {2nd},
+ note = {ISBN 978-1498716963},
+ url = {http://yihui.org/knitr/},
+}
diff --git a/bookclub-template.Rproj b/bookclub-template.Rproj
@@ -0,0 +1,18 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Website
diff --git a/index.Rmd b/index.Rmd
@@ -0,0 +1,37 @@
+---
+title: "BOOKNAME Book Club"
+author: "The R4DS Online Learning Community"
+date: "`r Sys.Date()`"
+site: bookdown::bookdown_site
+documentclass: book
+bibliography: book.bib
+biblio-style: apalike
+link-citations: yes
+github-repo: r4ds/bookclub-BOOKABBR
+description: "This is the product of the R4DS Online Learning Community's BOOKNAME Book Club."
+---
+
+# Welcome {-}
+
+Welcome to the bookclub!
+
+This is a companion for the book [_BOOKNAME_](BOOKURL) by BOOKAUTHORS (BOOKPUBLISHER, copyright BOOKCOPYRIGHT, [BOOKISBN](BOOKDOI)).
+This companion is available at [r4ds.io/BOOKABBR](https://r4ds.io/BOOKABBR).
+
+This website is being developed by the [R4DS Online Learning Community](https://rfordatasci.com). Follow along, and [join the community](https://r4ds.io/join) to participate.
+
+This companion follows the [R4DS Online Learning Community Code of Conduct](https://r4ds.io/conduct).
+
+## Book club meetings {-}
+
+- Each week, a volunteer will present a chapter from the book (or part of a chapter).
+ - **This is the best way to learn the material.**
+- Presentations will usually consist of a review of the material, a discussion, and/or a demonstration of the principles presented in that chapter.
+- More information about how to present is available in the [github repo](https://github.com/r4ds/bookclub-BOOKABBR).
+- Presentations will be recorded, and will be available on the [R4DS Online Learning Community YouTube Channel](https://r4ds.io/youtube).
+
+## Pace {-}
+
+- We'll _try_ to cover 1 chapter/week, but...
+- ...It's ok to split chapters when they feel like too much.
+- We will try to meet every week, but will likely take some breaks for holidays, etc.
diff --git a/preamble.tex b/preamble.tex
@@ -0,0 +1 @@
+\usepackage{booktabs}
