Skip to content

Helpers for project setup with quillt

Source: R/templates.R
setup-helpers.Rd

These helper are mostly inspired by the one in usethis from the tidyverse team and are useful to setup a new pkgdown project with quillt

Usage

use_coc()

use_contributing()

use_github_action_quillt_pkgdown()

use_github_action_lock_thread()

use_quillt_pkgdown(config_file = "_pkgdown.yml", destdir = "reference")

use_quillt_issue_template(
  issue_guide = TRUE,
  community = TRUE,
  so = TRUE,
  blank_issue = FALSE
)

Arguments

config_file

Path to the pkgdown yaml config file - could be set to be pkgdown/ subfolder.

destdir

Target directory for pkgdown docs. By default, it will be in reference sub directory for R Markdown related package using quillt.

issue_guide

default TRUE will add a link to https://yihui.org/issue/. You can pass a custom link as character vector. Set to FALSE to not include this option in the issue chooser.

community

default TRUE will add a link to https://community.rstudio.com/. You can pass a custom link as character vector. Set to FALSE to not include this option in the issue chooser.

so

default TRUE will add a link to https://stackoverflow.com/questions/tagged/r. You can pass a custom link as character vector. Set to FALSE to not include this option in the issue chooser.

blank_issue

FALSE by default. Sets to TRUE to allow blank issue with no template.

Details

  • use_coc(): use usethis::use_tidy_coc() and put _CODE\_OF\emphCONDUCT.md in .github/ directory setting the contact email to Rstudio one.

  • use_contributing(): Add a CONTRIBUTING.md file in .github/ following a template in quillt. Inspired by usethis::use_tidy_contributing().

  • use_quillt_pkgdown(): Create all the necessary files and configuration to configure a pkgdown website to use theming and organization for the R Markdown ecosystem. It adds pkgdown configuration, dependencies in DESCRIPTION, template for vignettes (including the Example gallery one) and other common assets.

  • use_github_action_quillt_pkgdown(): Set a Github Action workflow to build a pkgdown website and deploy to Netlify. The deployment action use allow a main deploy branch and PR previews. This action will be triggered on PR only for branch targetting master and with a name starting with pkgdown/

  • use_quillt_issue_template(): Add default issue templates for Github issues. See Github Docs