Updated documentation
This commit is contained in:
166
man/MNR.DB.Geometries.Rd
Normal file
166
man/MNR.DB.Geometries.Rd
Normal file
@@ -0,0 +1,166 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/db_geometries.R
|
||||
\name{MNR.DB.Geometries}
|
||||
\alias{MNR.DB.Geometries}
|
||||
\title{MNR database queries for Gemoetries}
|
||||
\value{
|
||||
A query object or a collected sf of the blocks
|
||||
|
||||
A query object or a collected sf of the conservation areas
|
||||
|
||||
A query object or a collected sf of the marine regions
|
||||
|
||||
A query object or collected query of the block marine regions
|
||||
|
||||
A query object or collected query of the block conservation
|
||||
areas
|
||||
}
|
||||
\description{
|
||||
MNR database queries for Gemoetries
|
||||
|
||||
MNR database queries for Gemoetries
|
||||
}
|
||||
\section{Super class}{
|
||||
\code{\link[AVSDevR.MarineNoiseRegistry:MNR.DB]{AVSDevR.MarineNoiseRegistry::MNR.DB}} -> \code{MNR.DB.Geometries}
|
||||
}
|
||||
\section{Methods}{
|
||||
\subsection{Public methods}{
|
||||
\itemize{
|
||||
\item \href{#method-MNR.DB.Geometries-getBlocks}{\code{MNR.DB.Geometries$getBlocks()}}
|
||||
\item \href{#method-MNR.DB.Geometries-getConservationAreas}{\code{MNR.DB.Geometries$getConservationAreas()}}
|
||||
\item \href{#method-MNR.DB.Geometries-getMarineRegions}{\code{MNR.DB.Geometries$getMarineRegions()}}
|
||||
\item \href{#method-MNR.DB.Geometries-getBlockMarineRegions}{\code{MNR.DB.Geometries$getBlockMarineRegions()}}
|
||||
\item \href{#method-MNR.DB.Geometries-getBlockConservationAreaDistances}{\code{MNR.DB.Geometries$getBlockConservationAreaDistances()}}
|
||||
\item \href{#method-MNR.DB.Geometries-clone}{\code{MNR.DB.Geometries$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.Geometries-getBlocks"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Geometries-getBlocks}{}}}
|
||||
\subsection{Method \code{getBlocks()}}{
|
||||
Fetches the Oil & Gas block information from the database
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Geometries$getBlocks(
|
||||
with_geometries = TRUE,
|
||||
ordered = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{with_geometries}}{\if{html}{\out{<logical>}} Also fetch the block geometries}
|
||||
|
||||
\item{\code{ordered}}{\if{html}{\out{<logical>}} Sort the blocks (has an overhead)}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Geometries-getConservationAreas"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Geometries-getConservationAreas}{}}}
|
||||
\subsection{Method \code{getConservationAreas()}}{
|
||||
Retrieves the Conservation Areas from the database
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Geometries$getConservationAreas(with_geometries = TRUE, collect = TRUE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{with_geometries}}{\if{html}{\out{<logical>}} Also fetch the geometries}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Geometries-getMarineRegions"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Geometries-getMarineRegions}{}}}
|
||||
\subsection{Method \code{getMarineRegions()}}{
|
||||
Retrieves the Marine Regions from the database
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Geometries$getMarineRegions(with_geometries = TRUE, collect = TRUE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{with_geometries}}{\if{html}{\out{<logical>}} Also fetch the geometries}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Geometries-getBlockMarineRegions"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Geometries-getBlockMarineRegions}{}}}
|
||||
\subsection{Method \code{getBlockMarineRegions()}}{
|
||||
Retrieves the block marine region map table from the
|
||||
database
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Geometries$getBlockMarineRegions(collect = TRUE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Geometries-getBlockConservationAreaDistances"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Geometries-getBlockConservationAreaDistances}{}}}
|
||||
\subsection{Method \code{getBlockConservationAreaDistances()}}{
|
||||
Retrieves the block conservation areas map table from the
|
||||
database
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Geometries$getBlockConservationAreaDistances(collect = TRUE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Geometries-clone"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Geometries-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.Geometries$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>}}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user