Documentation added

man/SessionLogger.Rd

@@ -0,0 +1,80 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/sessionLogger.R
+\name{SessionLogger}
+\alias{SessionLogger}
+\title{R shiny application session logger}
+\value{
+The wrapped R Shiny application
+
+A function which can be called to cancel the "end" log
+}
+\description{
+R shiny application session logger
+
+R shiny application session logger
+}
+\details{
+Wraps an R Shiny application or attaches to an R Shiny session to log session
+start / end events
+}
+\section{Methods}{
+\subsection{Public methods}{
+\itemize{
+\item \href{#method-SessionLogger-wrap}{\code{SessionLogger$wrap()}}
+\item \href{#method-SessionLogger-attachSession}{\code{SessionLogger$attachSession()}}
+\item \href{#method-SessionLogger-clone}{\code{SessionLogger$clone()}}
+}
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-SessionLogger-wrap"></a>}}
+\if{latex}{\out{\hypertarget{method-SessionLogger-wrap}{}}}
+\subsection{Method \code{wrap()}}{
+Wraps an existing R Shiny application with a session logger
+\subsection{Usage}{
+\if{html}{\out{<div class="r">}}\preformatted{SessionLogger$wrap(app)}\if{html}{\out{</div>}}
+}
+
+\subsection{Arguments}{
+\if{html}{\out{<div class="arguments">}}
+\describe{
+\item{\code{app}}{An R Shiny application (\link[shiny]{shinyApp})}
+}
+\if{html}{\out{</div>}}
+}
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-SessionLogger-attachSession"></a>}}
+\if{latex}{\out{\hypertarget{method-SessionLogger-attachSession}{}}}
+\subsection{Method \code{attachSession()}}{
+Attaches to an existing R Shiny session to log start / end
+events.
+\subsection{Usage}{
+\if{html}{\out{<div class="r">}}\preformatted{SessionLogger$attachSession(session)}\if{html}{\out{</div>}}
+}
+
+\subsection{Arguments}{
+\if{html}{\out{<div class="arguments">}}
+\describe{
+\item{\code{session}}{An R Shiny session to log start / end events for}
+}
+\if{html}{\out{</div>}}
+}
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-SessionLogger-clone"></a>}}
+\if{latex}{\out{\hypertarget{method-SessionLogger-clone}{}}}
+\subsection{Method \code{clone()}}{
+The objects of this class are cloneable with this method.
+\subsection{Usage}{
+\if{html}{\out{<div class="r">}}\preformatted{SessionLogger$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>}}
+}
+}
+}