Skip to content

cynkra/blockr.ui

Repository files navigation

blockr.ui

Lifecycle: experimental ci CRAN status Codecov test coverage

The goal of blockr.ui is to provide an alternative user interface for {blockr.core}.

Installation

You can install the development version of blockr.ui from GitHub with:

# install.packages("devtools")
devtools::install_github("cynkra/blockr.ui")

Example

To run the demo app:

library(blockr.ui)
library(blockr.dplyr)
library(blockr.sdtm)
library(blockr.io)

Sys.setenv("DASHBOARD_TYPE" = "dock")
run_demo_app()

Create a new block

Block properties

Append block and invalid state

Join independant data

Rearrange output on a grid

App options

There are few options you can customize through setting up environment variables:

  • N_STACKS_COLORS: how many colors to support in the stack color pickerInput. Default is 40.
  • STACKS_COLOR_PALETTE: the color palette type. Default is spectral. We use hcl.colors to setup the palette.
  • DASHBOARD_TYPE: either grid to leverage {gridstackr} or dock for {dockVieweR}. Default is dock.
    • DOCK_THEME: when DASHBOARD_TYPE is dock you can customize the dock skin. Choose among c("light", "abyss", "dark", "vs", "dracula", "replit"). Default is replit.

Development

JS code is managed by esbuild {charpente}. To create a new JS file do and compile the entire project:

charpente::create_js("file-name")
charpente::build_js()