Installation

To install the sbShinyModules from GitHub, please use the remotes package. Run the following command in your R console:

# Install remotes package if not already installed
install.packages("remotes")

# Install sbShinyModules from GitHub
remotes::install_github("sbg/sbShinyModules")

Note on dependencies

The sbShinyModules package has a core set of functionalities that are available by default upon installation. However, the get_all_project_files() function requires the xattrs package for extended
attribute support.

For Unix-based Systems (Linux, macOS)

• xattrs Package: To use the get_all_project_files() function, you need to install the xattrs package. On Unix-based systems, you can install it with:

R

remotes::install_github("hrbrmstr/xattrs")

• System Dependencies: On some Unix-based systems, additional system libraries might be required. For example, on Ubuntu Linux, you need the libattr1-dev library. Install it using:

sudo apt-get update
sudo apt-get install libattr1-dev

For macOS users, additional system libraries are typically not required for xattrs, but ensure your system is up-to-date.

For Windows Users

The get_all_project_files() function is not available on Windows systems because it depends on the xattrs package, which requires extended attribute functions that are not supported on Windows.

By default, all other modules and functions of the sbShinyModules package will be available to you without the xattrs package.

Note: The Data Studio RStudio environments on Seven Bridges Platforms are based on Ubuntu, a Unix-based system. While this should facilitate the installation of the xattrs package, you might still need to install the libattr1-dev library before the xattrs package can be successfully installed.