--- title: "Quick start" linkTitle: "Quick start" type: docs weight: 3 --- # SPS example usage To start with SPS after installation: ## Load package Load the `systemPipeShiny` package in your R session. ```{r sps_load_package, eval=TRUE, collapse=TRUE} library(systemPipeShiny) ``` ## Initialize `SPS` project Before launching the `SPS` application, a project environment needs to be created with the following command. ```{r spsinit, eval=FALSE} spsInit() ``` For this demo, the project directory structure is written to a temporary directory on a user's system. For a real project, it should be written to a defined and user controlled location on a system rather than a temporary directory. ```{r spsinit_temp, eval=TRUE, collapse=TRUE} sps_tmp_dir <- tempdir() spsInit(app_path = sps_tmp_dir, change_wd = FALSE, project_name = "SPSProject") sps_dir <- file.path(sps_tmp_dir, "SPSProject") ``` ### SPS project structure The file and directory structure of an SPS project is organized as follows.
SPS_xx/ ├── server.R | ├── global.R | Most important server, UI and global files, unless special needs, `global.R` is the only file you need to edit manually ├── ui.R | ├── deploy.R | Deploy helper file ├── config | Important app config files. Do not edit them by hand if you don't know │ ├── sps.db | SPS database │ ├── sps_options.yaml | SPS default option list │ └── tabs.csv | SPS tab registration information ├── data | App example data files │ ├── xx.csv ├── R | All SPS additional tab files, helper R function, interactive guides files │ ├── tab_xx.R ├── README.md ├── results | Not in use for this current version, but you can store some data been generated from the app │ └── README.md └── www | Internet resources ├── css | CSS files │ └── sps.css ├── img | App image resources │ └── xx.png ├── js | Javascripts │ └── xx.js ├── loading_themes | Loading screen files │ └── xx.html └── plot_list | Image files for custom visualization tab thumbnails └── plot_xx.jpg## Launch `SPS` By default, the working directory will be set inside the project folder automatically. To launch the `SPS` Shiny application, one only needs to execute the following command. ```{r, eval=FALSE} shiny::runApp() ``` Alternatively, when using RStudio one can click the `Run App` button in the top right corner. After the SPS app has been launched, clicking the "Continue to app" button on the welcome screen will open the main dashboard (Fig.2).