Skip to contents

The goal of ussie is to make a first attempt at a demo package for folks to build for the “Building Tidy Tools” course at rstudio::conf(2022L).

Installation

You can install the development version of ussie from GitHub with:

# install.packages("devtools")
devtools::install_github("rstudio-conf-2022/ussie")

Notes

I want to note the functions that I used to manage the development of this package:

Package-development setup:

  • usethis::edit_r_profile()

Git setup - good for git setup, but current tidyverse recommendation is to use https rather than ssh:

  • gert::git_config_global_set() can use for "user.name", "user.email"
  • usethis::git_vaccinate()
  • usethis::git_default_branch_configure() set default for future repos
    • usethis::git_default_branch_rename() rename default branch of existing repo

GitHub setup:

  • usethis::create_github_token()
  • gitcreds::gitcreds_set()

Verification:

  • usethis::git_sitrep()

Development:

  • usethis::create_package()
  • usethis::use_git()
  • usethis::use_github()
  • usethis::use_readme_rmd()
  • usethis::use_package()
  • usethis::use_test()
  • usethis::use_github_action_check_release() minimal check
    • usethis::use_github_action_check_standard() if thinking of CRAN
  • usethis::use_package_doc(), then usethis::use_tibble()
    • add #' @importFrom rlang .data to ussie-package.R - prefer this to usethis::use_tidy_eval()
    • even better: usethis::use_import_from(), e.g. usethis::use_import_from("rlang", ".data")
  • usethis::use_pkgdown(), usethis::use_github_action("pkgdown")
  • usethis::use_github_pages(): configure GH pages once the pkg action succeds, wait a minute et voilà!
  • usethis::pr_init(), usethis::pr_push(), usethis::pr_finish(), usethis::pr_resume()
  • usethis::use_news_md()

note, we need {shiny}, {diffviewer} to review snapshot tests