Create a project for a new report

Source: R/create_report.R

This function works very similarly to usethis::create_project(), but sets up the project to generate an Excel report using quickReport

create_report(
  path,
  excel_files = getOption("qr.default_template"),
  r_files = NULL,
  sql_files = NULL,
  rstudio = rstudioapi::isAvailable(),
  open = interactive()
)

Arguments

path

A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.
excel_files, r_files, sql_files

Optional directories containing pre-existing files to use in the report
rstudio

If TRUE, calls use_rstudio() to make the new package or project into an RStudio Project. If FALSE and a non-package project, a sentinel .here file is placed so that the directory can be recognized as a project by the here or rprojroot packages.
open

If TRUE, activates the new project:

  • If RStudio desktop, the package is opened in a new session.

  • If on RStudio server, the current RStudio project is activated.

  • Otherwise, the working directory and active project is changed.

Value

Path to the newly created project or package, invisibly.