Editable DataTables for shiny apps.

New Author: dmslabsbr Email: suporte@neoage.com.br

Orginial Author: Jason Bryer, Ph.D. Email: jason@bryer.org

New version by DMS

Use the devtools package to install the development version of DTedit:

External update based on code from DavidPatShuiFong/DTedit

devtools::install_github('dmslabsbr/dtedit2')

For a specific branch version, use:

devtools::install_github('dmslabsbr/dtedit2', ref='v0.22f')

The dtedit_demo will run a sample shiny app with to editable data tables.

DTedit::dtedit_demo()

Getting Started with DTedit

You can download a simple shiny app using DTedit here: inst/template/app.R

There are three steps to using DTedit in your shiny application.

1. Define callback function for inserting, updating, and deleting data.

my.insert.callback <- function(data, row) {
	mydata <- rbind(data, mydata)
	return(mydata)
}

my.update.callback <- function(data, olddata, row) {
	mydata[row,] <- data[1,]
	return(mydata)
}

my.delete.callback <- function(data, row) {
	mydata[row,] <- NULL
	return(mydata)
}

Typically these functions would interact with a database. As written here, the data would be lost between shiny sessions.

2. Create the dtedit object within your server function.

DTedit::dtedit(input, output,
	   name = 'mycontacts',
	   thedata = mydata,
	   edit.cols = c('name', 'email', 'useR', 'notes'),
	   edit.label.cols = c('Name', 'Email Address', 'Are they an R user?', 'Additional notes'),
	   input.types = c(notes='textAreaInput'),
	   view.cols = c('name', 'email', 'useR'),
	   callback.update = my.update.callback,
	   callback.insert = my.insert.callback,
	   callback.delete = my.delete.callback)

The input and output are passed from the server function. The name parameter will define the name of the object available to the uiOutput. The thedata is a data.frame for the initial view of the data table. This can be an empty (i.e. no rows) data.frame. The structure of the data.frame will define the inputs (e.g. factors will be drop down, Date will use dateInput, numerics will use numericInput, etc.). There are many other parameters to custom the behavior of dtedit, see ?dtedit for the full list.

• DMS Version 0.1.0 *

DTedit::dtedit(input, output,
               name = 'uiEdTable',
               thedata = tb_dadoss,
               view.cols = names(tb_dadoss),
               view.label.cols = c_v_colnames,
               edit.cols = c_ed_cols,
               edit.label.cols = c_ed_l_cols, 
               edit.require.cols = c_ed_cols,
               edit.require.label = 'The following fields are required: ',
               date.format = 'dd-mm-yyyy',
               input.types = c_ed_input_t,
               title.delete = "Apagar",
               title.delete.confirmation = 'Are you sure you want to delete this record?',
               title.edit = "Editar",
               title.add = "Novo Registro",
               label.delete = "Apagar",
               label.edit = "Editar", 
               label.add = "Novo",
               label.copy = "Copiar",
               label.cancel = "Cancelar",
               label.save = "Gravar",
               callback.update = my.update.callback,
               callback.insert = my.insert.callback,
               callback.delete = my.delete.callback)

The new parameters are:

• view.label.cols - character vector with the labels to use on the view;
• edit.require.cols - character vector with the column names required the user must edit/add;
• edit.require.label - the label of require message.
• date.format - the default for data format inputs.
• title.delete.confirmation - deletion confirmation message.
• label.delete - the label of the delete button.

3. Use uiOutput in your UI to display the editable data table.

The name you will pass to uiOutput is the name you passed to the dtedit created on the server side.

uiOutput('mycontacts')