timeInput: Create a time input

In burgerga/shinyTime: A Time Input Widget for Shiny

Create a time input

Description

Creates a time widget that consists of separate numeric inputs for the hours, minutes, and seconds. The input and output values of the time widget are instances of DateTimeClasses, these can be converted to and from character strings with strptime and strftime. Additionally, the input can be specified as a character string in the 'hh:mm:ss' format or an hms class. For a simple example app see shinyTimeExample.

Usage

timeInput(
  inputId,
  label,
  value = NULL,
  seconds = TRUE,
  minute.steps = NULL,
  use.civilian = FALSE,
  width = NULL
)

Arguments

inputId	The input slot that will be used to access the value.
label	Display label for the control, or NULL for no label.
value	The desired time value. Must be a instance of DateTimeClasses.
seconds	Show input for seconds. Defaults to TRUE.
minute.steps	Round time to multiples of minute.steps (should be a whole number). If not NULL sets seconds to FALSE.
use.civilian	Use civilian time (12-hour format) instead of 24-hour format.
width	The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

Value

Returns a POSIXlt object, which can be converted to a POSIXct object with as.POSIXct for more efficient storage.

See Also

strptime, strftime, DateTimeClasses

Other shinyTime functions: shinyTimeExample(), updateTimeInput()

Examples

## Only run examples in interactive R sessions
if (interactive()) {

ui <- fluidPage(
  # Default value is 00:00:00
  timeInput("time1", "Time:"),

  # Set to current time
  timeInput("time2", "Time:", value = Sys.time()),

  # Set to custom time
  timeInput("time3", "Time:", value = strptime("12:34:56", "%T")),

  # Set to custom time using hms
  timeInput("time4", "Time:", value = hms::as_hms("23:45:07")),

  # Set to custom time using character string
  timeInput("time5", "Time:", value = "21:32:43"),

  # Use hh:mm format
  timeInput("time6", "Time:", seconds = FALSE),

  # Use multiples of 5 minutes
  timeInput("time7", "Time:", minute.steps = 5),

  # Use civilian (non-military time)
  timeInput("time8", "Time:", use.civilian = TRUE)
)

shinyApp(ui, server = function(input, output) { })
}

burgerga/shinyTime documentation built on May 8, 2024, 5:42 p.m.