diff --git a/_bookdown.yml b/_bookdown.yml index a3af2ce3..dbe05cbb 100644 --- a/_bookdown.yml +++ b/_bookdown.yml @@ -53,9 +53,9 @@ rmd_files: [ "prompt-search-github.Rmd", "notes-intro.Rmd", - "classroom-overview.Rmd", - "ideas.Rmd", - "bookdown-cheat-sheet.Rmd", + "notes-classroom-overview.Rmd", + "notes-ideas.Rmd", + "notes-bookdown-cheat-sheet.Rmd", "80_shell.Rmd", diff --git a/bookdown-cheat-sheet.Rmd b/notes-bookdown-cheat-sheet.Rmd similarity index 51% rename from bookdown-cheat-sheet.Rmd rename to notes-bookdown-cheat-sheet.Rmd index 18151223..a3a6a498 100644 --- a/bookdown-cheat-sheet.Rmd +++ b/notes-bookdown-cheat-sheet.Rmd @@ -46,3 +46,31 @@ knitr::kable( ``` You can write citations, too. For example, we are using the **bookdown** package [@R-bookdown] in this sample book, which was built on top of R Markdown and **knitr** [@xie2015]. + +## How the square bracket links work + +Context: you prefer to link with text, not a chapter or section number. + + * GOOD! Here's a link to [Contributors]. + * BAD. You can see contributors in \@ref(contrib). + +Facts and vocabulary + + * Each chapter is a file. These files should begin with the chapter title using a level-one header, e.g., `# Chapter Title`. + * A chapter can be made up of sections, indicated by lower-level headers, e.g., `## A section within the chapter`. + * There are three ways to address a section when creating links within your book: + - **Explicit identifier**: In `# My header {#foo}` the explicit identifier is `foo`. + - **Automatically generated identifier**: `my-header` is the auto-identifier for `# My header`. Pandoc creates auto-identifiers according to rules laid out in [Extension: auto_identifiers](http://pandoc.org/README.html#extension-auto_identifiers). + - The header text, e.g., `My header` be used verbatim as an **implicit header reference**. See [Extension: implicit_header_references](http://pandoc.org/README.html#extension-implicit_header_references) for more. + * All 3 forms can be used to create cross-references but you build the links differently. + * Advantage of explicit identification: You are less likely to update the section header and then forget to make matching edits to references elsewhere in the book. + +How to make text-based links using explicit identifiers, automatic identifiers, and implicit references: + + * Use implicit reference alone to get a link where the text is exactly the section header: + - `[Introduce yourself to Git]` [Introduce yourself to Git] + - `[Success and operating systems]` [Success and operating systems] + * You can provide custom text for the link with all 3 methods of addressing a section: + - Implicit header reference: `[link text][Recommended Git clients]` [link text][Recommended Git clients] + - Explicit identifier: `[hello git! I'm Jenny](#hello-git)` [hello git! I'm Jenny](#hello-git) + - Automatic identifier: `[Any text you want](#recommended-git-clients)` [Any text you want](#recommended-git-clients) diff --git a/classroom-overview.Rmd b/notes-classroom-overview.Rmd similarity index 99% rename from classroom-overview.Rmd rename to notes-classroom-overview.Rmd index c5dacaff..42348675 100644 --- a/classroom-overview.Rmd +++ b/notes-classroom-overview.Rmd @@ -1,7 +1,7 @@ -# (PART) Classroom {-} - # Run a course with GitHub {#classroom-overview} +*This content is rather stale and unlikely to see further development.* + GitHub makes a wonderful platform on which to run a course. I've been doing this on [github.com](https://github.com) since 2014 in [STAT 545](http://stat545.com), an 80-student grad course in data analysis with R, and in a second large, code-intensive graduate course in statistical genomics. We're running all of the courses for UBC's [Master of Data Science program](https://ubc-mds.github.io) off a private instance of [GitHub Enterprise](https://enterprise.github.com/home) hosted in Canada. ## Benefits diff --git a/ideas.Rmd b/notes-ideas.Rmd similarity index 59% rename from ideas.Rmd rename to notes-ideas.Rmd index 2aad6225..2bd41dad 100644 --- a/ideas.Rmd +++ b/notes-ideas.Rmd @@ -1,8 +1,4 @@ -# (PART) Meta {-} - -# Notes - -Notes for future +Ideas for content ## Common workflow questions @@ -123,31 +119,3 @@ Workflows for group of 1, 2, 5, 10 - - - -## How the square bracket links work - -Context: you prefer to link with text, not a chapter or section number. - - * GOOD! Here's a link to [Contributors]. - * BAD. You can see contributors in \@ref(contrib). - -Facts and vocabulary - - * Each chapter is a file. These files should begin with the chapter title using a level-one header, e.g., `# Chapter Title`. - * A chapter can be made up of sections, indicated by lower-level headers, e.g., `## A section within the chapter`. - * There are three ways to address a section when creating links within your book: - - **Explicit identifier**: In `# My header {#foo}` the explicit identifier is `foo`. - - **Automatically generated identifier**: `my-header` is the auto-identifier for `# My header`. Pandoc creates auto-identifiers according to rules laid out in [Extension: auto_identifiers](http://pandoc.org/README.html#extension-auto_identifiers). - - The header text, e.g., `My header` be used verbatim as an **implicit header reference**. See [Extension: implicit_header_references](http://pandoc.org/README.html#extension-implicit_header_references) for more. - * All 3 forms can be used to create cross-references but you build the links differently. - * Advantage of explicit identification: You are less likely to update the section header and then forget to make matching edits to references elsewhere in the book. - -How to make text-based links using explicit identifiers, automatic identifiers, and implicit references: - - * Use implicit reference alone to get a link where the text is exactly the section header: - - `[Introduce yourself to Git]` [Introduce yourself to Git] - - `[Success and operating systems]` [Success and operating systems] - * You can provide custom text for the link with all 3 methods of addressing a section: - - Implicit header reference: `[link text][Recommended Git clients]` [link text][Recommended Git clients] - - Explicit identifier: `[hello git! I'm Jenny](#hello-git)` [hello git! I'm Jenny](#hello-git) - - Automatic identifier: `[Any text you want](#recommended-git-clients)` [Any text you want](#recommended-git-clients)