File: app_RLum.Rd

package info (click to toggle)
r-cran-rlumshiny 0.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,332 kB
  • sloc: javascript: 922; makefile: 2
file content (76 lines) | stat: -rw-r--r-- 2,963 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/app_RLum.R
\name{app_RLum}
\alias{app_RLum}
\title{Run Luminescence shiny apps}
\usage{
app_RLum(app = NULL, ...)
}
\arguments{
\item{app}{\code{\link{character}} (\strong{required}):
name of the application to start. See details for a list of available apps.}

\item{...}{further arguments to pass to \code{\link{runApp}}}
}
\description{
A wrapper for \code{\link{runApp}} to start interactive shiny apps for the R package Luminescence.
}
\details{
The RLumShiny package provides a single function from which all shiny apps can be started: \code{app_RLum()}.
It essentially only takes one argument, which is a unique keyword specifying which application to start.
See the table below for a list of available shiny apps and which keywords to use. If no keyword is used
a dashboard will be started instead, from which an application can be started.

\tabular{lcl}{
\strong{Application name:} \tab  \strong{Keyword:}  \tab \strong{Function:} \cr
Abanico Plot \tab \emph{abanico} \tab \code{\link{plot_AbanicoPlot}} \cr
Histogram \tab \emph{histogram} \tab \code{\link{plot_Histogram}} \cr
Kernel Density Estimate Plot \tab \emph{KDE} \tab \code{\link{plot_KDE}} \cr
Radial Plot \tab \emph{radialplot} \tab \code{\link{plot_RadialPlot}} \cr
Dose Recovery Test \tab \emph{doserecovery} \tab \code{\link{plot_DRTResults}} \cr
Cosmic Dose Rate \tab \emph{cosmicdose}  \tab \code{\link{calc_CosmicDoseRate}} \cr
CW Curve Transformation \tab \emph{transformCW} \tab \code{\link{CW2pHMi}}, \code{\link{CW2pLM}}, \code{\link{CW2pLMi}}, \code{\link{CW2pPMi}} \cr
Filter Combinations \tab \emph{filter} \tab \code{\link{plot_FilterCombinations}} \cr
Fast Ratio \tab \emph{fastratio} \tab \code{\link{calc_FastRatio}} \cr
Fading Correction \tab \emph{fading} \tab \code{\link{analyse_FadingMeasurement}}, \code{\link{calc_FadingCorr}} \cr
Test Stimulation Power \tab \emph{teststimulationpower} \tab  \code{\link{plot_RLum}} \cr
Scale Gamma Dose Rate \tab \emph{scalegamma} \tab \code{scale_GammaDose} \cr
RCarb app \tab \emph{RCarb} \tab \link[RCarb:model_DoseRate]{RCarb::model_DoseRate}
}

The \code{app_RLum()} function is just a wrapper for \code{\link{runApp}}.
Via the \code{...} argument further arguments can be directly passed to \code{\link{runApp}}.
See \code{?shiny::runApp} for further details on valid arguments.
}
\examples{

\dontrun{
# Dashboard
app_RLum()

# Plotting apps
app_RLum("abanico")
app_RLum("histogram")
app_RLum("KDE")
app_RLum("radialplot")
app_RLum("doserecovery")

# Further apps
app_RLum("cosmicdose")
app_RLum("transformCW")
app_RLum("filter")
app_RLum("fastratio")
app_RLum("fading")
app_RLum("surfaceexposure")
app_RLum("teststimulationpower")
app_RLum("scalegamma")
app_RLum("RCarb")
}

}
\seealso{
\code{\link{runApp}}
}
\author{
Christoph Burow, University of Cologne (Germany)
}