Run the teacher dashboard from PostgreSQL — run_dashboard

Connects to a PostgreSQL tracking database and opens the teacher dashboard. Connection settings default to LEARNRTRACKR_POSTGRES_* environment variables. If postgres_schema is supplied, the PostgreSQL search_path is set to that schema before dashboard data are read.

Usage

run_dashboard_postgres(
  dbname = Sys.getenv("LEARNRTRACKR_POSTGRES_DB", unset = "learnrtrackr"),
  postgres_host = Sys.getenv("LEARNRTRACKR_POSTGRES_HOST", unset = "127.0.0.1"),
  postgres_port = as.integer(Sys.getenv("LEARNRTRACKR_POSTGRES_PORT", unset = "5432")),
  postgres_user = Sys.getenv("LEARNRTRACKR_POSTGRES_USER", unset = "learnrtrackr"),
  postgres_password = Sys.getenv("LEARNRTRACKR_POSTGRES_PASSWORD", unset = ""),
  postgres_schema = Sys.getenv("LEARNRTRACKR_POSTGRES_SCHEMA", unset = ""),
  initialize = FALSE,
  tutorial_id = NULL,
  rule = c("last", "best", "first"),
  include_unregistered = TRUE,
  group_id = Sys.getenv("LEARNRTRACKR_PILOT_GROUP_ID", unset = ""),
  host = "127.0.0.1",
  access_token = NULL,
  token_envvar = "LEARNRTRACKR_DASHBOARD_TOKEN",
  allow_remote = FALSE,
  ...
)

Arguments

dbname: PostgreSQL database name. Defaults to LEARNRTRACKR_POSTGRES_DB, or "learnrtrackr" when unset.
postgres_host: PostgreSQL host. Defaults to LEARNRTRACKR_POSTGRES_HOST, or "127.0.0.1" when unset.
postgres_port: PostgreSQL port. Defaults to LEARNRTRACKR_POSTGRES_PORT, or 5432 when unset.
postgres_user: PostgreSQL user. Defaults to LEARNRTRACKR_POSTGRES_USER, or "learnrtrackr" when unset.
postgres_password: Optional PostgreSQL password. Defaults to LEARNRTRACKR_POSTGRES_PASSWORD.
postgres_schema: Optional PostgreSQL schema. Defaults to LEARNRTRACKR_POSTGRES_SCHEMA.
initialize: If TRUE, create postgres_schema when supplied and create missing tracking tables before launching the dashboard.
tutorial_id: Optional tutorial identifier selected at startup. If NULL, the first available tutorial is selected.
rule: Scoring rule passed to gradebook().
include_unregistered: If TRUE, include attempted questions that were not registered with register_questions().
group_id: Optional registered student group identifier selected at startup. If supplied, the dashboard is filtered to students in that group.
host: Host passed to shiny::runApp(). Defaults to "127.0.0.1" for local-only use.
access_token: Optional dashboard token. If supplied, the dashboard asks for this token before showing data.
token_envvar: Environment variable used to read a dashboard token when access_token is NULL. Set to NULL to disable environment lookup.
allow_remote: If FALSE, refuse to run on a non-local host unless an access token is configured.
...: Additional arguments passed to shiny::runApp().

Value

The return value of shiny::runApp().

Examples

if (FALSE) { # \dontrun{
run_dashboard_postgres(
  postgres_schema = "learnrtrackr_pilot",
  group_id = "A",
  access_token = Sys.getenv("LEARNRTRACKR_DASHBOARD_TOKEN")
)
} # }