Package 'shiny.info'

Busy or not

Description

Displays a spinner indicating if there are any calculations running on the server side.

Usage

busy(loader = "dots", position = "top right")

Arguments

loader	character or list. If character given, then it selects from one of a few available loaders (look Details for more). By using list you can create your custom loder. List needs to have structure loader <- list(css<-"CSS CODE", html <- div("CODE TO DISPLAY")).
position	character with position of the parameter. Default "top right".

Details

Currently available loaders: "dots", "spinner".

Solution inspired by: https://colinfay.me/watch-r-shiny/.

Value

shiny tag List with js script, style of spinner and display div

---

Display message on the top-right corner

Description

Display message on the top-right corner

Usage

display(message, position = "top right", type = "message")

Arguments

message	character with any message you want
position	character with position of the parameter. Default "top right".
type	character with display type to specify the id. Default to "message"

Value

div which wraps your message to display it in the position corner of your shiny app.

---

Git information

Description

Displays git information from the repository of the current working space.

Usage

git_info(position = "top right")

Arguments

position

character with position of the parameter. Default "top right".

---

Creates a panel for all info boxes so they do not overlap

Description

Creates a panel for all info boxes so they do not overlap

Usage

info_panel(..., position = "top right")

Arguments

...	calls with info elements
position	character with position of the parameter. Default "top right".

Value

div which wraps your all info boxes to display it in the position corner of your shiny app.

---

UI output for info value

Description

UI output for info value

Usage

info_value(id, position = "top right")

Arguments

id	output id to render
position	character with position of the parameter. Default "top right".

Value

div which wraps rendered value to display it in the position corner of your shiny app.

---

Wrapper for info_panel function

Description

Wrapper for info_panel function

Usage

infoPanel(..., position = "top right")

Arguments

...	calls with info elements
position	character with position of the parameter. Default "top right".

Value

div which wraps your all info boxes to display it in the position corner of your shiny app.

---

Inspect button server

Description

Helps to easlily stop app at any moment for debugging or checking state.

Usage

inspect_btn_server(input)

Arguments

input

Shiny server input.

Value

observeEvent for Inspect button

---

Inspect button UI

Description

Helps to easlily stop app at any moment for debugging or checking state.

Usage

inspect_btn_ui(label = "Inspect", position = "top right")

Arguments

label	label for debug button. Default "Inspect"
position	character with position of the parameter. Default "top right".

Value

div with "shinyinfo_inspect_btn".

---

Powered by

Description

Displays information about authors of the shiny app.

Usage

powered_by(
  company_name = NULL,
  link = "#",
  position = "top right",
  logo = NULL,
  logo_width = "120px",
  logo_height = "auto",
  inline = FALSE
)

Arguments

company_name	character with the creator of the app
link	link to the creator's website
position	character with position of the parameter. Default "top right".
logo	web link to a logo image or name of the image file in ./www
logo_width	width of the logo in pixels
logo_height	height of the logo in pixels
inline	if TRUE, display text and logo on the same line

Value

div with "powered by".

---

Server render function for info value

Description

Server render function for info value

Usage

render_info_value(
  expr,
  env = parent.frame(),
  quoted = FALSE,
  sep = " ",
  add_name = TRUE
)

Arguments

expr	value to render
env	The environment in which to evaluate expr. Default parent.frame()
quoted	Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable. Default FALSE
sep	A separator passed to cat to be appended after each element.
add_name	Should expression name be added. Default TRUE

Details

If you want to use it with toggle_info(), you have to add outputOptions(output, [info value id], suspendWhenHidden = FALSE) to force rendering when the value is hidden.

Value

Shiny render function to be saved as an element of output.

Examples

if(interactive()) {
library(shiny)
library(shiny.info)

ui <- fluidPage(
  info_value("value_to_display")
)

server <- function(input, output, session) {
  test_reactive <- reactiveVal("some value")
  output$value_to_display <- render_info_value(expr = test_reactive())
  # next line is required to work with toggle_info()
  outputOptions(output, "value_to_display", suspendWhenHidden = FALSE)
}
}

---

Server render function for rendering informations about user session (app URL, username and pixel ratio)

Description

Server render function for rendering informations about user session (app URL, username and pixel ratio)

Usage

render_session_info()

Details

Use it with info_value UI function. If you want to use it with toggle_info(), you have to add outputOptions(output, [session info id], suspendWhenHidden = FALSE) to force rendering when the value is hidden.

Value

Shiny render function to be saved as an element of output.

Examples

if(interactive()) {
library(shiny)
library(shiny.info)

ui <- fluidPage(
   info_value("session_info")
)

server <- function(input, output, session) {
  outputsession_info <- render_session_info()
  # next line is required to work with toggle_info()
  outputOptions(output, "session_info", suspendWhenHidden = FALSE)
}
}

---

Toggle showing info with keyboard shortcut

Description

Toggle showing info with keyboard shortcut

Usage

toggle_info(shortcut = "Ctrl+Shift+K", hidden_on_start = TRUE)

Arguments

shortcut	keys that trigger showing info. Shortcut can include special keys: Ctrl, Alt, Shift. Keys should be separated with '+' sign. Default Ctrl+Shift+K
hidden_on_start	should info panels be hidden on start of the application? Default TRUE.

Details

toggle_info() should be added in the header of the application in ui.R, since it adds a script with toggle functionality. If you want to use it with info_value, you have to add outputOptions(output, [info value id], suspendWhenHidden = FALSE) to force rendering when the value is hidden.

Value

JS script that adds toggle functionality.

Examples

if (interactive()) {
library(shiny)
library(shiny.info)

ui <- fluidPage(
  toggle_info(),
  shiny.info::display("test message"),
  shiny.info::info_value("test_input_value", "bottom right"),
  textInput(inputId = "test_input", label = NULL)
)

server <- function(input, output, session) {
  output$test_input_value <- shiny.info::render_info_value(input$test_input)
  outputOptions(output, "test_input_value", suspendWhenHidden = FALSE)
}

shinyApp(ui = ui, server = server)
}

---

Display version of the app

Description

Displays the version of the app by default using VERSION global variable.

Usage

version(ver = NULL, position = "top right")

Arguments

ver	(default NULL) custom version number
position	character with position of the parameter. Default "top right".

Examples

version() # if VERSION global variable exists
version("1.2.1") # with custom version number

---