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/UFApplication.Rd Normal file
View File

@@ -0,0 +1,95 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ufApplication.R
\name{UFApplication}
\alias{UFApplication}
\title{Core UserFrosting (basic AdminLTE themed) R shiny application}
\value{
An R Shiny application suitable for \link[shiny]{runApp}
}
\description{
Core UserFrosting (basic AdminLTE themed) R shiny application
Core UserFrosting (basic AdminLTE themed) R shiny application
}
\section{Super classes}{
\code{AVSDevR.ShinyApplication::FrameApplication} -> \code{AVSDevR.ShinyApplication::AdminLTEApplication} -> \code{UFApplication}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-UFApplication-configureUF}{\code{UFApplication$configureUF()}}
\item \href{#method-UFApplication-app}{\code{UFApplication$app()}}
\item \href{#method-UFApplication-clone}{\code{UFApplication$clone()}}
}
}
\if{html}{\out{
<details><summary>Inherited methods</summary>
<ul>
<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>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="AdminLTEApplication" data-id="frameUI"><a href='../../AVSDevR.ShinyApplication/html/AdminLTEApplication.html#method-AdminLTEApplication-frameUI'><code>AVSDevR.ShinyApplication::AdminLTEApplication$frameUI()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="AdminLTEApplication" data-id="ui"><a href='../../AVSDevR.ShinyApplication/html/AdminLTEApplication.html#method-AdminLTEApplication-ui'><code>AVSDevR.ShinyApplication::AdminLTEApplication$ui()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="AdminLTEApplication" data-id="withSkin"><a href='../../AVSDevR.ShinyApplication/html/AdminLTEApplication.html#method-AdminLTEApplication-withSkin'><code>AVSDevR.ShinyApplication::AdminLTEApplication$withSkin()</code></a></span></li>
</ul>
</details>
}}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-UFApplication-configureUF"></a>}}
\if{latex}{\out{\hypertarget{method-UFApplication-configureUF}{}}}
\subsection{Method \code{configureUF()}}{
Sets up the UserFrosting configuration for the application
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{UFApplication$configureUF(
uri,
with_users = TRUE,
user_optional = FALSE,
app_name = NULL
)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{uri}}{\if{html}{\out{<character>}} The URI for the UserFrosting API instance}
\item{\code{with_users}}{\if{html}{\out{<logical>}} Enable UF user API interaction}
\item{\code{user_optional}}{\if{html}{\out{<logical>}} Are users optional?}
\item{\code{app_name}}{\if{html}{\out{<character>}} The shiny application name for the UF API}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-UFApplication-app"></a>}}
\if{latex}{\out{\hypertarget{method-UFApplication-app}{}}}
\subsection{Method \code{app()}}{
Instantiates an R Shiny application with UserFrosting
support.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{UFApplication$app()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-UFApplication-clone"></a>}}
\if{latex}{\out{\hypertarget{method-UFApplication-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{UFApplication$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>}}
}
}
}