Shiny Matrix Input Field

Implements a custom matrix input field.



title: Matrix Input for Shiny

Travis-CI Build Status Coverage Status CRAN_Status_Badge

This package provides an input field to enter matrix conveniently in a shiny application. It supports tabbing and jumping linewise in the matrix, copy-pasting from other spread sheets applications.

Screenshot Simple Matrix

Installation

From CRAN:

install.packages("shinyMatrix")

From GitHub:

if (require("devtools")) install_github("INWTlab/shinyMatrix")

Usage

UI

The input field is generated by the function matrixInput

matrixInput <- function(inputId,
                        value = matrix("", 1, 1),
                        inputClass = "",
                        rows = list(),
                        cols = list(),
                        class = "character",
                        paste = FALSE,
                        copy = FALSE){
  [...]
}

You can define parameters as follows:

Parameter Description
inputId id of html element
value matrix
inputClass class of html element (Class matrix-input is added automatically)
rows list of parameters (see below)
cols list of parameters (see below)
class class of resulting matrix (numeric and character) is supported
paste add pasting functionality
copy add copy functionality

Parameter rows / cols take a list of arguments. The following is supported

Parameter Description
n number of rows (is calculated from value per default)
names show row/colnames (names are taken from value)
editableNames should row/colnames be editable?
extend should rows/cols be automatically be added if table is filled to the last row / column?
delta how many blank rows/cols should be added
createHeader name of javascript function to override default function to create table header. The function needs to have the table element and the data object as argument
updateHeader name of javascript function to override default function to update table header. The function needs to have the table element and the data object as argument
getHeader name of javascript function to override default function to get names from the html table. The function needs to have the table element as argument

Call the matrixInput function in your UI generating, e.g. ui.R

## numeric matrix
matrixInput("matrix1", class = "numeric")
 
## editable rownames
matrixInput("matrix2",
  rows = list(
    names = TRUE,
    editableNames = TRUE),
  data = matrix(letters[1:12], 3, 4)
)

Get value

You can access the value from the matrix input using input$inputId in your server function. The result will always be a matrix of the class defined in matrixInput.

Update Input Field

You can update the input field using updateMatrixInput

updateMatrixInput(session, inputId, value = NULL)

value is the data object. In the future there should be also support to update the other parameters.

Example Apps

You find the code for the example app in inst/appXXX.

library(shinyMatrix)
 
## Basic Functionality
startApplication("app")
 
## Copy Pasting
startApplication("appCopy")
 
## Update Matrix Input from R
startApplication("appUpdate")
 
## Editable rownames
startApplication("appRownames")
 
## Extend Matrix Automatically
startApplication("appExtend")
 
## Custom Column Header 
startApplication("appCustom")

News

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("shinyMatrix")

0.1.0 by Andreas Neudecker, 5 months ago


Browse source code at https://github.com/cran/shinyMatrix


Authors: Andreas Neudecker


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports shiny, jsonlite

Suggests testthat, covr


Imported by ASSOCShiny, CTAShiny, PROBShiny, SHELF.


See at CRAN