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

67
man/SessionLoggerDB.Rd Normal file
View File

@@ -0,0 +1,67 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sessionLogger.R
\name{SessionLoggerDB}
\alias{SessionLoggerDB}
\title{R shiny application session database logger}
\description{
R shiny application session database logger
R shiny application session database logger
}
\details{
Logs session start / stop events to database
}
\section{Super class}{
\code{AVSDevR.ShinyApplication::SessionLogger} -> \code{SessionLoggerDB}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-SessionLoggerDB-new}{\code{SessionLoggerDB$new()}}
\item \href{#method-SessionLoggerDB-clone}{\code{SessionLoggerDB$clone()}}
}
}
\if{html}{\out{
<details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="SessionLogger" data-id="attachSession"><a href='../../AVSDevR.ShinyApplication/html/SessionLogger.html#method-SessionLogger-attachSession'><code>AVSDevR.ShinyApplication::SessionLogger$attachSession()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.ShinyApplication" data-topic="SessionLogger" data-id="wrap"><a href='../../AVSDevR.ShinyApplication/html/SessionLogger.html#method-SessionLogger-wrap'><code>AVSDevR.ShinyApplication::SessionLogger$wrap()</code></a></span></li>
</ul>
</details>
}}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-SessionLoggerDB-new"></a>}}
\if{latex}{\out{\hypertarget{method-SessionLoggerDB-new}{}}}
\subsection{Method \code{new()}}{
Initialises the instance with a database client
\link[AVSDevR.DBClient]{DBClient}
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{SessionLoggerDB$new(db_client)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{db_client}}{<\link[AVSDevR.DBClient]{DBClient}> A DBClient instance}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-SessionLoggerDB-clone"></a>}}
\if{latex}{\out{\hypertarget{method-SessionLoggerDB-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{SessionLoggerDB$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>}}
}
}
}