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

Updated documentation

Browse Source
This commit is contained in:
Craig Williams
2026-02-10 17:54:17 +00:00
parent 0a648f92f0
commit 02813b0583
19 changed files with 1669 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
man/MNR.DB.Actuals.Rd Normal file
View File

@@ -0,0 +1,123 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/db_actuals.R
\name{MNR.DB.Actuals}
\alias{MNR.DB.Actuals}
\title{MNR database queries for Actuals}
\value{
A tibble of Actuals for \code{refs}
A tibble of the proposed actuals
}
\description{
MNR database queries for Actuals
MNR database queries for Actuals
}
\section{Super class}{
\code{\link[AVSDevR.MarineNoiseRegistry:MNR.DB]{AVSDevR.MarineNoiseRegistry::MNR.DB}} -> \code{MNR.DB.Actuals}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-MNR.DB.Actuals-selectActuals}{\code{MNR.DB.Actuals$selectActuals()}}
\item \href{#method-MNR.DB.Actuals-selectProposedActuals}{\code{MNR.DB.Actuals$selectProposedActuals()}}
\item \href{#method-MNR.DB.Actuals-upsertActuals}{\code{MNR.DB.Actuals$upsertActuals()}}
\item \href{#method-MNR.DB.Actuals-deleteActuals}{\code{MNR.DB.Actuals$deleteActuals()}}
\item \href{#method-MNR.DB.Actuals-clone}{\code{MNR.DB.Actuals$clone()}}
}
}
\if{html}{\out{
<details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="AVSDevR.MarineNoiseRegistry" data-topic="MNR.DB" data-id="getDBClient"><a href='../../AVSDevR.MarineNoiseRegistry/html/MNR.DB.html#method-MNR.DB-getDBClient'><code>AVSDevR.MarineNoiseRegistry::MNR.DB$getDBClient()</code></a></span></li>
<li><span class="pkg-link" data-pkg="AVSDevR.MarineNoiseRegistry" data-topic="MNR.DB" data-id="initialize"><a href='../../AVSDevR.MarineNoiseRegistry/html/MNR.DB.html#method-MNR.DB-initialize'><code>AVSDevR.MarineNoiseRegistry::MNR.DB$initialize()</code></a></span></li>
</ul>
</details>
}}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.DB.Actuals-selectActuals"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.DB.Actuals-selectActuals}{}}}
\subsection{Method \code{selectActuals()}}{
Select the actuals for \code{refs}
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Actuals$selectActuals(refs)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{refs}}{\if{html}{\out{<character>}} The MNR application noise source references}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.DB.Actuals-selectProposedActuals"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.DB.Actuals-selectProposedActuals}{}}}
\subsection{Method \code{selectProposedActuals()}}{
Returns the current actuals for a application or builds a
default actuals list from the proposed locations if there are none
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Actuals$selectProposedActuals(refs)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{refs}}{\if{html}{\out{<character>}} The MNR application noise source references}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.DB.Actuals-upsertActuals"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.DB.Actuals-upsertActuals}{}}}
\subsection{Method \code{upsertActuals()}}{
Upserts the actuals in the actuals.sf into the database
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Actuals$upsertActuals(actuals.sf)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{actuals.sf}}{\if{html}{\out{<sf>}} An sf table containing the new actuals}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.DB.Actuals-deleteActuals"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.DB.Actuals-deleteActuals}{}}}
\subsection{Method \code{deleteActuals()}}{
Deletes actuals for \code{refs}
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Actuals$deleteActuals(refs)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{refs}}{\if{html}{\out{<character>}} The MNR application noise source references}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.DB.Actuals-clone"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.DB.Actuals-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Actuals$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>}}
}
}
}