SPS example usage
To start with SPS after installation:
systemPipeShiny package in your R session.
## Loading required package: shiny
## Loading required package: spsUtil
## Loading required package: spsComps
## Loading required package: drawer
Before launching the
SPS application, a project environment needs to be created with the
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.
sps_tmp_dir <- tempdir() spsInit(app_path = sps_tmp_dir, change_wd = FALSE, project_name = "SPSProject")
## [SPS-INFO] 2021-04-12 11:31:39 Start to create a new SPS project
## [SPS-INFO] 2021-04-12 11:31:39 Create project under /tmp/RtmpgROsL7/SPSProject
## [SPS-INFO] 2021-04-12 11:31:39 Now copy files
## [SPS-INFO] 2021-04-12 11:31:39 Create SPS database
## [SPS-INFO] 2021-04-12 11:31:39 Created SPS database method container
## [SPS-INFO] 2021-04-12 11:31:39 Creating SPS db...
## [SPS-DANGER] 2021-04-12 11:31:39 Done, Db created at '/tmp/RtmpgROsL7/SPSProject/config/sps.db'. DO NOT share this file with others or upload to open access domains. ## [SPS-INFO] 2021-04-12 11:31:39 Key md5 ae88518aa6cce9a5af24d37c4c3c1b16 ## [SPS-INFO] 2021-04-12 11:31:39 SPS project setup done!
sps_dir <- file.path(sps_tmp_dir, "SPSProject")
SPS project structure
The file and directory structure of an SPS project is organized as follows.
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.
After the SPS app has been launched, clicking the “Continue to app” button on the welcome screen will open the main dashboard (Fig.2).
Figure 2: Snapshot of SPS' UI.
- Welcome screen.
- Module tabs.
- User defined custom tabs.
- The Canvas tab.
- All SPS tabs has this description on top. It is highly recommend to click here to expand and read the full the description for the first time.
Alternatively, when using RStudio one can click the
Run App button in the top right corner.
In addition, in Rstudio the global.R file will be automatically
opened when the
SPS project is created. Custom changes can be made inside this file
before the app launches. Later we will discuss how to change and create new custom tabs and change other settings.