R/AVSDevR.ShinyApplication
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation added

Browse Source
This commit is contained in:
Craig Williams
2026-02-10 18:17:01 +00:00
parent ab9172f88d
commit 56f1c979df
14 changed files with 795 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
man/FrameApplication.Rd Normal file
View File

@@ -0,0 +1,164 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/frameApplication.R
\name{FrameApplication}
\alias{FrameApplication}
\title{Basic R shiny application}
\value{
A DBClient instance which is useable for the session
An R Shiny application suitable for \link[shiny]{runApp}
}
\description{
Basic R shiny application
Basic R shiny application
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-FrameApplication-new}{\code{FrameApplication$new()}}
\item \href{#method-FrameApplication-withSessionLogger}{\code{FrameApplication$withSessionLogger()}}
\item \href{#method-FrameApplication-withBootstrap4Shim}{\code{FrameApplication$withBootstrap4Shim()}}
\item \href{#method-FrameApplication-getSessionDBClient}{\code{FrameApplication$getSessionDBClient()}}
\item \href{#method-FrameApplication-ui}{\code{FrameApplication$ui()}}
\item \href{#method-FrameApplication-server}{\code{FrameApplication$server()}}
\item \href{#method-FrameApplication-app}{\code{FrameApplication$app()}}
\item \href{#method-FrameApplication-clone}{\code{FrameApplication$clone()}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-new"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-new}{}}}
\subsection{Method \code{new()}}{
Creates a new R Shiny application
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$new(appPage = NULL, language = NULL)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{appPage}}{\if{html}{\out{<module>}} An application module (attempts to load
pages/application.R if not supplied)}
\item{\code{language}}{\if{html}{\out{<character>}} The language to use for the HTML page
(defaults to "en")}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-withSessionLogger"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-withSessionLogger}{}}}
\subsection{Method \code{withSessionLogger()}}{
Binds the application to a session logger
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$withSessionLogger(sessionLogger)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{sessionLogger}}{The session logger instance to use}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-withBootstrap4Shim"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-withBootstrap4Shim}{}}}
\subsection{Method \code{withBootstrap4Shim()}}{
Loads with the Bootstrap 4 shim CSS file
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$withBootstrap4Shim()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-getSessionDBClient"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-getSessionDBClient}{}}}
\subsection{Method \code{getSessionDBClient()}}{
Returns a DBClient instance for the current session
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$getSessionDBClient(
session,
db_config = NULL,
allowFailure = FALSE
)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{session}}{An R Shiny session}
\item{\code{db_config}}{The database configuration to use (will attempt to find
and load a global.R or .env.R file if not supploed)}
\item{\code{allowFailure}}{If a configuration cannot be loaded or a connection
to the database cannot be made, do not abort}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-ui"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-ui}{}}}
\subsection{Method \code{ui()}}{
Creates the UI component for an R Shiny application
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$ui()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-server"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-server}{}}}
\subsection{Method \code{server()}}{
Creates the server component for an R Shiny application
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$server(input, output, session, ...)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{input}}{The UI inputs bound for the session}
\item{\code{output}}{The UI outputs bound for the session}
\item{\code{session}}{The current session}
\item{\code{...}}{Parameters passed into the inner application}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-app"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-app}{}}}
\subsection{Method \code{app()}}{
Instantiates an R Shiny application
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$app()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-FrameApplication-clone"></a>}}
\if{latex}{\out{\hypertarget{method-FrameApplication-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{FrameApplication$clone(deep = FALSE)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{deep}}{Whether to make a deep clone.}
}
\if{html}{\out{</div>}}
}
}
}