Nothing
#' @include report.R
NULL
#' One sentence of help below each threshold
#'
#' @noRd
threshold_help <- c(
BD = "Optical features per square micron. Bruker flags 0.05 to 2.25 on MAX, FLEX and PRO, and 0.1 to 1.8 on SPRINT.",
FoV = "Share of fields of view the scanner could count. Bruker flags below 75%.",
PCL = "R squared of the positive controls against their concentrations. Bruker flags below 0.95.",
LoD = "How far the 0.5 fM positive control sits above background, in standard deviations. Bruker flags below 2.",
Positive_factor = "Scaling from the positive controls. Bruker flags outside 0.3 to 3.",
House_factor = "Scaling from the housekeeping genes. Bruker flags outside 0.1 to 10.",
Housekeeping_detected = "Housekeeping genes above background in the sample.",
Ligation_order = "1 when the ligation positive controls are in order, else 0.",
Ligation_R2 = "R squared of the ligation positive controls against their positions.",
Ligation_NEG = "Largest ligation negative minus the detection limit.",
Haemolysis = "log2 of miR-451a over miR-23a-3p; above 7 suggests haemolysis."
)
threshold_pages <- c(
BD = "bd",
FoV = "fov",
PCL = "pcl",
LoD = "lod",
Positive_factor = "pf",
House_factor = "hgf"
)
threshold_help_block <- function(metric) {
page <- threshold_pages[metric]
more <- if (!is.na(page)) {
bslib::popover(
shiny::tags$button(
type = "button",
class = "btn btn-link btn-sm p-0 ms-1 align-baseline",
`aria-label` = paste("More about", qc_metric_labels[[metric]]),
shiny::icon("circle-question", `aria-hidden` = "true")
),
help_page(page),
title = qc_metric_labels[[metric]],
options = list(customClass = "nacho-help")
)
}
shiny::helpText(threshold_help[[metric]], more)
}
threshold_metrics <- function(x) {
known <- qc_metrics[
qc_metrics %in% intersect(names(x@samples), names(x@thresholds))
]
known[vapply(
known,
function(metric) any(!is.na(x@samples[[metric]])),
logical(1)
)]
}
threshold_range <- function(values, limits) {
finite <- c(values[is.finite(values)], limits[is.finite(limits)])
if (!length(finite)) {
return(c(0, 1))
}
range(pretty(c(0, finite)))
}
limits_to_slider <- function(limits, range) {
pmin(pmax(limits, range[1]), range[2])
}
slider_to_limits <- function(value, range, original) {
limits <- slider_limits(value, range, original)
if (is.integer(original)) as.integer(limits) else limits
}
slider_limits <- function(value, range, original) {
lower <- if (is.infinite(original[1]) && value[1] <= range[1]) {
original[1]
} else {
value[1]
}
if (length(original) == 1) {
return(lower)
}
upper <- if (is.infinite(original[2]) && value[2] >= range[2]) {
original[2]
} else {
value[2]
}
c(lower, upper)
}
count_metrics <- c("Housekeeping_detected", "Ligation_order")
slider_step <- function(metric, range, limits) {
if (metric %in% count_metrics) {
return(1)
}
finite <- limits[is.finite(limits)]
exponent <- floor(log10(diff(range) / 100))
for (candidate in 10^seq(exponent, exponent - 3)) {
ratio <- finite / candidate
if (all(abs(ratio - round(ratio)) < 1e-8)) {
return(candidate)
}
}
10^exponent
}
threshold_inputs <- function(x, limits, ns, metrics = threshold_metrics(x)) {
shiny::tagList(lapply(metrics, function(metric) {
range <- threshold_range(x@samples[[metric]], limits[[metric]])
shiny::tagList(
shiny::sliderInput(
ns(metric),
label = paste0(qc_metric_labels[[metric]], " (", metric, ")"),
min = range[1],
max = range[2],
value = limits_to_slider(limits[[metric]], range),
step = slider_step(metric, range, limits[[metric]])
),
threshold_help_block(metric)
)
}))
}
normalisation_choices <- function(x) {
c(
"GEO",
"GLM",
"RUVg",
if (identical(x@settings[["panel"]], "mirna")) {
c("stable_mirna", "total_mirna", "spike_in", "ligation")
}
)
}
threshold_groups <- list(
Imaging = c("BD", "FoV"),
Controls = c("PCL", "LoD", "Positive_factor"),
Content = c("House_factor", "Housekeeping_detected"),
miRNA = c("Ligation_order", "Ligation_R2", "Ligation_NEG", "Haemolysis")
)
threshold_group_body <- function(x, limits, ns, group) {
metrics <- intersect(threshold_metrics(x), threshold_groups[[group]])
if (length(metrics) == 0) {
return(shiny::helpText("Not measured for these data."))
}
threshold_inputs(x, limits, ns, metrics)
}
#' Sidebar panel that each page of the app opens
#'
#' @noRd
app_sidebar_panels <- c(
Data = "Preset",
"QC metrics" = "Imaging",
Controls = "Controls",
Counts = "Content",
Normalisation = "Normalisation",
Batch = "Normalisation",
Samples = "Preset",
Export = "Preset"
)
preset_choices <- c(nSolver = "nsolver", "NACHO 2" = "legacy")
preset_label <- function(preset) {
names(preset_choices)[match(preset, preset_choices)]
}
mod_thresholds_ui <- function(id) {
ns <- shiny::NS(id)
group_panel <- function(group) {
bslib::accordion_panel(group, shiny::uiOutput(ns(paste0("group_", group))))
}
bslib::accordion(
id = ns("sections"),
multiple = FALSE,
open = "Preset",
bslib::accordion_panel(
"Preset",
shiny::selectInput(
ns("preset"),
"Threshold preset",
preset_choices
),
shiny::selectInput(
ns("instrument"),
"Instrument",
c(MAX = "max", FLEX = "flex", PRO = "pro", SPRINT = "sprint")
),
shiny::actionButton(
ns("reset"),
"Reset",
icon = shiny::icon("rotate-left", `aria-hidden` = "true"),
`aria-label` = "Reset the thresholds to the preset",
class = "btn-outline-secondary btn-sm"
),
shiny::tags$div(
class = "mt-3",
shiny::fileInput(
ns("thresholds_file"),
"Load thresholds (YAML)",
accept = c(".yml", ".yaml")
)
),
shiny::helpText(
"Read a file from the Export page, or one written with write_thresholds()."
)
),
bslib::accordion_panel(
"Normalisation",
shiny::selectInput(ns("method"), "Method", "GEO"),
shiny::conditionalPanel(
"input.method == 'RUVg'",
ns = ns,
shiny::numericInput(
ns("ruv_k"),
"Unwanted factors",
value = 1,
min = 1,
max = 10,
step = 1
),
shiny::helpText("Use suggest_ruv_k() in R to choose this number.")
),
shiny::selectInput(
ns("background"),
"Background",
c("none", "mean", "mean_2sd", "median", "max", "geo")
),
shiny::selectInput(
ns("background_mode"),
"Background mode",
c("threshold", "subtract")
)
),
!!!lapply(names(threshold_groups), group_panel)
)
}
settings_of <- function(x) {
method <- x@settings[["normalisation_method"]]
list(
normalisation_method = method,
ruv_k = if (method == "RUVg") as.integer(x@settings[["ruv_k"]] %||% 1L),
background = x@settings[["background"]],
background_mode = x@settings[["background_mode"]]
)
}
mod_thresholds_server <- function(id, data, page = shiny::reactive(NULL)) {
shiny::moduleServer(id, function(input, output, session) {
shiny::observeEvent(page(), {
if (page() %in% names(app_sidebar_panels)) {
bslib::accordion_panel_set("sections", app_sidebar_panels[[page()]])
}
})
current <- shiny::reactiveVal()
base <- shiny::reactiveVal()
published <- shiny::reactiveVal()
chosen <- shiny::reactiveVal()
revision <- shiny::reactiveVal(0L)
start <- function(limits) {
base(limits)
current(limits)
revision(shiny::isolate(revision()) + 1L)
}
show_preset <- function(limits) {
instrument <- limits[["instrument"]]
shiny::updateSelectInput(session, "preset", selected = limits[["preset"]])
shiny::updateSelectInput(
session,
"instrument",
selected = if (is.na(instrument)) "max" else instrument
)
}
shiny::observeEvent(data(), {
x <- data()
start(x@thresholds)
published(x@thresholds)
chosen(settings_of(x))
show_preset(x@thresholds)
shiny::updateSelectInput(
session,
"method",
choices = normalisation_choices(x),
selected = x@settings[["normalisation_method"]]
)
if (!is.null(chosen()$ruv_k)) {
shiny::updateNumericInput(session, "ruv_k", value = chosen()$ruv_k)
}
shiny::updateSelectInput(
session,
"background",
selected = x@settings[["background"]]
)
shiny::updateSelectInput(
session,
"background_mode",
selected = x@settings[["background_mode"]]
)
})
reset <- function() {
limits <- shiny::req(base())
start(nacho_thresholds(
instrument = input$instrument,
preset = input$preset,
haemolysis = any(is.finite(limits[["Haemolysis"]]))
))
}
shiny::observeEvent(
list(input$preset, input$instrument),
{
limits <- shiny::req(current(), input$preset, input$instrument)
instrument <- limits[["instrument"]]
if (is.na(instrument)) {
instrument <- "max"
}
moved <- !identical(input$preset, limits[["preset"]]) ||
!identical(input$instrument, instrument)
if (moved) reset()
},
ignoreInit = TRUE
)
for (group in names(threshold_groups)) {
local({
group <- group
output[[paste0("group_", group)]] <- shiny::renderUI({
revision()
threshold_group_body(
shiny::req(data()),
shiny::req(base()),
session$ns,
group
)
})
shiny::outputOptions(
output,
paste0("group_", group),
suspendWhenHidden = FALSE
)
})
}
shiny::observeEvent(input$reset, reset())
shiny::observeEvent(input$thresholds_file, {
if (is.null(data())) {
notify_user(
"Load RCC files or the example data before you load thresholds.",
"warning"
)
return(invisible(NULL))
}
path <- input$thresholds_file[["datapath"]][1]
limits <- tryCatch(
read_thresholds(path),
nacho_error = function(cnd) {
message <- cli::ansi_strip(rlang::cnd_message(cnd))
notify_user(
sub(
basename(path),
input$thresholds_file[["name"]][1],
message,
fixed = TRUE
),
"error"
)
NULL
}
)
if (!is.null(limits)) {
start(limits)
show_preset(limits)
}
})
for (metric in qc_metrics) {
local({
metric <- metric
shiny::observeEvent(
input[[metric]],
{
x <- shiny::req(data())
original <- shiny::req(base())
shiny::req(metric %in% threshold_metrics(x))
range <- threshold_range(x@samples[[metric]], original[[metric]])
limits <- current()
updated <- slider_to_limits(
input[[metric]],
range,
original[[metric]]
)
if (!identical(limits[[metric]], updated)) {
limits[[metric]] <- updated
current(limits)
}
},
ignoreInit = TRUE
)
})
}
current_thresholds <- shiny::reactive(shiny::req(current()))
settled <- shiny::debounce(current_thresholds, 500)
shiny::observeEvent(settled(), published(current()))
thresholds <- shiny::reactive(shiny::req(published()))
shiny::observeEvent(
list(
input$method,
input$ruv_k,
input$background,
input$background_mode
),
{
previous <- shiny::req(chosen())
method <- input$method %||% previous$normalisation_method
chosen(list(
normalisation_method = method,
ruv_k = if (method == "RUVg") as.integer(input$ruv_k %||% 1L),
background = input$background %||% previous$background,
background_mode = input$background_mode %||% previous$background_mode
))
},
ignoreInit = TRUE
)
settings <- shiny::reactive(shiny::req(chosen()))
list(
thresholds = thresholds,
current_thresholds = current_thresholds,
settings = settings,
reset = reset
)
})
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.