create_shiny: Create a shiny dashboard

View source: R/create_shiny.R

create_shinyR Documentation

Create a shiny dashboard

Description

Creates a new shiny dashboard as a package at given path; the package is named as the last folder in the path.

Usage

create_shiny(
  path,
  use_git = TRUE,
  use_github = use_git,
  use_ci = use_github,
  use_precommit = use_ci,
  use_coverage = use_ci,
  use_lintr = TRUE,
  use_tests = TRUE,
  ...,
  open = FALSE
)

Arguments

path

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

use_git

Initialise and make initial commits to a local git repository. By default is TRUE.

use_github

Create and push to a GitHub repository. By default takes value of use_git. If set to TRUE, use_git must also be TRUE.

use_ci

Set up a GitHub Action job to run R CMD CHECK. By default takes value of use_github. If set to TRUE, use_github must also be TRUE.

use_precommit

Set up precommit to run checks before any commit. By default takes value of use_ci. If set to TRUE, use_git must also be TRUE.

use_coverage

Set up covr and, if using GitHub, a GitHub Action to run code coverage and use the Codecov service. By default takes value of use_ci.

use_lintr

Set up lintr. By default is TRUE.

use_tests

Set up testthat. By default is TRUE.

...

Additional arguments passed to golem::create_golem()

open

Boolean. Open the created project?

Value

The path to the created package, invisibly.


MarkMc1089/devpacker documentation built on April 19, 2022, 4:48 p.m.