R/use_bst_file.R

Defines functions use_bst_report use_bst_analysis use_bst_setup use_bst_readme use_bst_gitignore use_bst_file

Documented in use_bst_analysis use_bst_file use_bst_gitignore use_bst_readme use_bst_report use_bst_setup

#' Write a template file
#'
#' Rather than using `create_bst_project()` to start a new project folder, you
#' may use `use_bst_file()` to write a single file from any project template.
#' The functions `use_bst_gitignore()` and `use_bst_readme()` are shortcuts for
#' `use_bst_file("gitignore")` and `use_bst_file("readme")`.
#'
#' @inheritParams starter::use_project_file
#' @inheritParams create_bst_project
#' @name use_file
#' @seealso [`create_bst_project()`]
#' @examples
#' if (FALSE) {
#' # create gitignore file
#' use_bst_file("gitignore")
#' use_bst_gitignore()
#'
#' # create README.md file
#' use_bst_file("readme")
#' use_bst_readme()
#' }
NULL

#' @rdname use_file
#' @export
use_bst_file <- function(name = NULL,
                         filename = NULL,
                         open = interactive()) {
  # if template is NULL, use default template ----------------------------------
  template <- .select_template()

  starter::use_project_file(name = name, filename = filename,
                            template = template, open = open)
}

#' @rdname use_file
#' @export
use_bst_gitignore <- function(filename = NULL) {
  use_bst_file(name = "gitignore", filename = filename)
}

#' @rdname use_file
#' @export
use_bst_readme <- function(filename = NULL) {
  use_bst_file(name = "readme", filename = filename)
}


#' @rdname use_file
#' @export
use_bst_setup <- function(filename = NULL) {
  use_bst_file(name = "setup", filename = filename)
}

#' @rdname use_file
#' @export
use_bst_analysis <- function(filename = NULL) {
  use_bst_file(name = "analysis", filename = filename)
}

#' @rdname use_file
#' @export
use_bst_report <- function(filename = NULL) {
  use_bst_file(name = "report", filename = filename)
}
ddsjoberg/bstfun documentation built on July 4, 2023, 10:59 a.m.