spsInit: Create a SystemPipeShiny project

Description Usage Arguments Details Value Examples

View source: R/spsCore.R

Description

To run a SPS app, you need to first create a SPS project, a directory contains the required files.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
spsInit(
  app_path = getwd(),
  project_name = glue::glue("SPS_{format(Sys.time(), '%Y%m%d')}"),
  database_name = "sps.db",
  overwrite = FALSE,
  change_wd = TRUE,
  verbose = FALSE,
  open_files = TRUE,
  colorful = TRUE
)

Arguments

app_path

path, a directory where do you want to create this project, must exist.

project_name

Your project name, default is SPS_ + time

database_name

deprecated in current version. project database name, recommend to use the default name: "sps.db". It is used to store app meta information.

overwrite

bool, overwrite the app_path if there is a folder that has the same name as project_name?

change_wd

bool, when creation is done, change working directory into the project?

verbose

bool, do you want additional message?

open_files

bool, If change_wd == TRUE and you are also in Rstudio, it will open up global.R for you

colorful

bool, should message from this function be colorful?

Details

Make sure you have write permission to app_path.

The database in not used in current version.

Value

creates the project folder

Examples

1
2
3
if(interactive()){
    spsInit(change_wd = FALSE)
}

systemPipeR/systemPipeShiny documentation built on June 1, 2021, 6:42 a.m.