spsInit: Create a SystemPipeShiny project

In systemPipeR/systemPipeS: systemPipeShiny: An Interactive Framework for Workflow Management and Visualization

Create a SystemPipeShiny project

Description

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

Usage

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

if(interactive()){
    spsInit(change_wd = FALSE)
}

systemPipeR/systemPipeS documentation built on Oct. 21, 2023, 12:18 p.m.