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

95
man/AdminLTEApplication.Rd Normal file
View File

@@ -0,0 +1,95 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/adminLTEApplication.R
\name{AdminLTEApplication}
\alias{AdminLTEApplication}
\title{AdminLTE (bootstrap dashboard) themed R shiny application}
\value{
R Shiny tagList for the frame UI
R Shiny tagList for an AdminLTE UI
}
\description{
AdminLTE (bootstrap dashboard) themed R shiny application
AdminLTE (bootstrap dashboard) themed R shiny application
}
\section{Super class}{
\code{AVSDevR.ShinyApplication::FrameApplication} -> \code{AdminLTEApplication}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-AdminLTEApplication-withSkin}{\code{AdminLTEApplication$withSkin()}}
\item \href{#method-AdminLTEApplication-frameUI}{\code{AdminLTEApplication$frameUI()}}
\item \href{#method-AdminLTEApplication-ui}{\code{AdminLTEApplication$ui()}}
\item \href{#method-AdminLTEApplication-clone}{\code{AdminLTEApplication$clone()}}
}
}
\if{html}{\out{
<details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="app"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-app'><code>AVSDevR.ShinyApplication::FrameApplication$app()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="getSessionDBClient"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-getSessionDBClient'><code>AVSDevR.ShinyApplication::FrameApplication$getSessionDBClient()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="initialize"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-initialize'><code>AVSDevR.ShinyApplication::FrameApplication$initialize()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="server"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-server'><code>AVSDevR.ShinyApplication::FrameApplication$server()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="withBootstrap4Shim"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-withBootstrap4Shim'><code>AVSDevR.ShinyApplication::FrameApplication$withBootstrap4Shim()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="FrameApplication" data-id="withSessionLogger"><a href='../../AVSDevR.ShinyApplication/html/FrameApplication.html#method-FrameApplication-withSessionLogger'><code>AVSDevR.ShinyApplication::FrameApplication$withSessionLogger()</code></a></span></li>
</ul>
</details>
}}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-AdminLTEApplication-withSkin"></a>}}
\if{latex}{\out{\hypertarget{method-AdminLTEApplication-withSkin}{}}}
\subsection{Method \code{withSkin()}}{
Uses a specific AdminLTE skin colour
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{AdminLTEApplication$withSkin(skin)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{skin}}{\if{html}{\out{<character>}} The AdminLTE skin colour to use}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-AdminLTEApplication-frameUI"></a>}}
\if{latex}{\out{\hypertarget{method-AdminLTEApplication-frameUI}{}}}
\subsection{Method \code{frameUI()}}{
Returns the basic FrameApplication UI without the AdminLTE
page body.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{AdminLTEApplication$frameUI()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-AdminLTEApplication-ui"></a>}}
\if{latex}{\out{\hypertarget{method-AdminLTEApplication-ui}{}}}
\subsection{Method \code{ui()}}{
AdminLTE ui for an R Shiny application
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{AdminLTEApplication$ui()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-AdminLTEApplication-clone"></a>}}
\if{latex}{\out{\hypertarget{method-AdminLTEApplication-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{AdminLTEApplication$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>}}
}
}
}