Data

Tools

Indexes

Applications

Experiments

Open Source Science

bookdown-template

The bookdown template used by the survey team of Rethink Priorities.

https://github.com/rethinkpriorities/bookdown-template

Science Score: 18.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

The bookdown template used by the survey team of Rethink Priorities.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 6
  • Releases: 0
Created over 4 years ago · Last pushed over 3 years ago
Metadata Files
Readme Citation

README.md

Rethink Priorities bookdown Template

Update 29 Mar 2022: We are leaning towards switching to quarto as it can do most of what our template does, and more, and will be maintained by RStudio.

The Rethink Priorities bookdown template is, as the name indicates, a template for creating bookdown books used by the survey team at Rethink Priorities. The main goal of this template is to serve as a skeleton project that can be copied and used in other projects. Additionally, it contains some chapters that serve as tutorials for different features of this bookdown format.

Installation

  1. Clone this repository from GitHub
  2. Install the rethinkpriorities R package
  3. (Go to the Build tab and click on "Build Website" to preview the book)

Usage

  1. Replace the contents of index.Rmd with content relevant to the project (e.g., an introduction/summary of the project and contributions)
  2. Remove the chapter files and add your own
  3. Update the _bookdown.yml file to refer to the new chapters specified in the rmd_files parameter (by default it lists the tutorial chapters)

Building the book

  1. Go to the Build tab and click on "Build Website"
  2. Done! The book should be visible in the Viewer pane and the resulting files should be stored in the docs folder

Citation (citations.Rmd) 

---
bibliography: references.bib
---

# Citations

It's possible to use citations with this template.

Our recommendation is to use Zotero and the Visual Editor in RStudio to insert a citation. In the Visual Editor, click on the Insert button and then on Citation to select a citation from your Zotero library. You can select one or more citations. Click on Insert to insert the citekey of the citation in the document. This will also create a new `.bib` file if the file did not exist yet or add it to the file if it did already exist.

You have to make sure that this file is also linked in the `YAML` options of `index.Rmd`.

Here's an example of a citation: [@alexander2019]

The main limitation of using citations this way is that the chapters have to be in the main folder (and not in a subfolder) because otherwise the bibliography path is not the same between the `index.Rmd` file and the chapter files, which throws the visual editor off.

GitHub Events

Total
Last Year

Dependencies

renv/library/R-4.1/x86_64-apple-darwin17.0/crayon/DESCRIPTION cran
  • grDevices * imports
  • methods * imports
  • utils * imports
  • mockery * suggests
  • rstudioapi * suggests
  • testthat * suggests
  • withr * suggests
renv/library/R-4.1/x86_64-apple-darwin17.0/filelock/DESCRIPTION cran
  • callr >= 2.0.0 suggests
  • covr * suggests
  • testthat * suggests
renv/library/R-4.1/x86_64-apple-darwin17.0/keyring/DESCRIPTION cran
  • R6 * imports
  • askpass * imports
  • assertthat * imports
  • filelock * imports
  • openssl * imports
  • rappdirs * imports
  • sodium * imports
  • tools * imports
  • utils * imports
  • yaml * imports
  • callr * suggests
  • covr * suggests
  • mockery * suggests
  • testthat * suggests
  • withr * suggests
renv/library/R-4.1/x86_64-apple-darwin17.0/renv/DESCRIPTION cran
  • utils * imports
  • BiocManager * suggests
  • R6 * suggests
  • cli * suggests
  • covr * suggests
  • devtools * suggests
  • knitr * suggests
  • miniUI * suggests
  • packrat * suggests
  • pak * suggests
  • remotes * suggests
  • reticulate * suggests
  • rmarkdown * suggests
  • rstudioapi * suggests
  • shiny * suggests
  • testthat * suggests
  • uuid * suggests
  • yaml * suggests
renv/library/R-4.1/x86_64-apple-darwin17.0/rethinkpriorities/DESCRIPTION cran
  • assertthat * imports
  • dplyr * imports
  • ggplot2 * imports
  • httr * imports
  • huxtable * imports
  • janitor * imports
  • kableExtra * imports
  • keyring * imports
  • labelled * imports
  • purrr * imports
  • readr * imports
  • recipes * imports
  • rmarkdown * imports
  • stats * imports
  • stringr * imports
  • tools * imports
  • treemapify * imports
  • vtable * imports
renv/library/R-4.1/x86_64-apple-darwin17.0/sodium/DESCRIPTION cran
  • knitr * suggests
  • rmarkdown * suggests
renv/library/R-4.1/x86_64-apple-darwin17.0/systemfonts/DESCRIPTION cran
  • R >= 3.2.0 depends
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 2.1.0 suggests
  • tools * suggests