makeAutoReportTab | R Documentation |
Make a table to be rendered in a shiny app providing automated reports from a given user or registry as obtained from the shiny session object provided or environmental variables when run inside an app container.
makeAutoReportTab(
session,
namespace = character(),
user = rapbase::getUserName(session),
group = rapbase::getUserGroups(session),
orgId = rapbase::getUserReshId(session),
type = "subscription",
mapOrgId = NULL,
includeReportId = FALSE
)
session |
A shiny session object |
namespace |
String naming namespace. Defaults to |
user |
Character string providing the username. Introduced as a new
argument when running apps inside containers. Default value is set to
|
group |
Character string defining the registry, normally corresponding
to the R package name and the value stemming from the SHINYPROXY_GROUPS
environment variable. Introduced as a new argument when running apps inside
containers. Default value is set to |
orgId |
Character string or integer defining the organization (id) for
|
type |
Character string defining the type of auto reports to tabulate.
Must be one of |
mapOrgId |
Data frame containing the two columns 'name' and 'id' corresponding to unique name and id of organizations. Default is NULL in which case the ids provided in auto report data will be used. In case mapOrgId is not NULL but no id match is found the id found in the auto report data will also be used |
includeReportId |
Logical if the unique report id should be added as the last column in the table. FALSE by default. |
Each table record (line) represents a uniquely defined automated report.
For each line two shiny action buttons are provided to allow
for editing and deleting of each entry. For applications
implementing this table observing events on these action buttons may be used
to allow users to manage automated reports by GUI. The
action buttons for editing and deleting are provided with the static input
ids edit_button and del_button and upon clicking the
button part of their ids will change to the unique id of the
report. Hence, a GUI call for editing a report can be caught by
shiny::observeEvent("edit_button")
and within this event the
report id is obtained by collecting the string after the double underscore,
e.g. strsplit(input$edit_button, "__")[[1]][2]
.
Optionally, report id may be provided as the last column in the table to allow further development for registry specific purposes. Regardless, this column should normally be hidden in the GUI.
Take a look at the example shiny server function in rapRegTemplate on how this function may be implemented.
Matrix providing a table to be rendered in a shiny app
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.