Developer tools

SPS is not only a framework to run interactive workflow and visualize data, but also a framework with abundant developer tools for building Shiny apps, writing R markdowns, integrating R-HTML and general R utilities.

These developer toolkits are distributed in supporting packages. If you like some of the functionality from SPS and think installing the whole framework is too expensive (time consuming), cherry-pick the functionality you want in following categories:

  • spsCpmps: Shiny/Rmarkdown UI components, and Shiny server functions.
  • drawer: Shiny/Rmarkdown/HTML interactive image editing tool.
  • spsUtil: General R utilities, like pretty logging functions.

Install

All these supporting packages are available on CRAN. We recommend to use the modern package manager {pak} to install packages.

if(!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/")

Pick and install packages as your need

pak::pkg_install("spsCpmps")
pak::pkg_install("drawer")
pak::pkg_install("spsUtil")

Linux

If you are on Linux, you need to install some system dependencies before R package installation. To figure out what system dependencies and command, run:

paste("sudo", pak::pkg_system_requirements("spsComps"))
## [1] "sudo apt-get install -y libcurl4-openssl-dev"
## [2] "sudo apt-get install -y libssl-dev"          
## [3] "sudo apt-get install -y make"                
## [4] "sudo apt-get install -y libicu-dev"          
## [5] "sudo apt-get install -y pandoc"
paste("sudo", pak::pkg_system_requirements("drawer"))
## [1] "sudo apt-get install -y make"       "sudo apt-get install -y libicu-dev"
## [3] "sudo apt-get install -y pandoc"
paste("sudo", pak::pkg_system_requirements("spsUtil"))
## [1] "sudo apt-get install -y libcurl4-openssl-dev"
## [2] "sudo apt-get install -y libssl-dev"          
## [3] "sudo apt-get install -y libicu-dev"

We are rendering this doc in Ubuntu. If your Linux distribution is different, commands above will be different.

Functions reference manual

In documents, we only highlight some important functions. Please read the reference manuals for details of every function.

Last modified 2021-10-10: Bot build site (d0c34823)