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

167
man/MNR.GeoPlot.Rd Normal file
View File

@@ -0,0 +1,167 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/geoPlot.R
\name{MNR.GeoPlot}
\alias{MNR.GeoPlot}
\title{MNR GIS plot base map generator}
\value{
A plolty object base map
The plotly object
}
\description{
MNR GIS plot base map generator
MNR GIS plot base map generator
}
\details{
Base layers are loaded and cached on first call to each of the boot methods.
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-MNR.GeoPlot-new}{\code{MNR.GeoPlot$new()}}
\item \href{#method-MNR.GeoPlot-bootLayers}{\code{MNR.GeoPlot$bootLayers()}}
\item \href{#method-MNR.GeoPlot-bootQuadrants}{\code{MNR.GeoPlot$bootQuadrants()}}
\item \href{#method-MNR.GeoPlot-bootConservationAreas}{\code{MNR.GeoPlot$bootConservationAreas()}}
\item \href{#method-MNR.GeoPlot-makeBasePlot}{\code{MNR.GeoPlot$makeBasePlot()}}
\item \href{#method-MNR.GeoPlot-boundMap}{\code{MNR.GeoPlot$boundMap()}}
\item \href{#method-MNR.GeoPlot-clone}{\code{MNR.GeoPlot$clone()}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.GeoPlot-new"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-new}{}}}
\subsection{Method \code{new()}}{
Initialises the object by building the grid lines
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.GeoPlot$new()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.GeoPlot-bootLayers"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-bootLayers}{}}}
\subsection{Method \code{bootLayers()}}{
Loads the JNCC layers required from file for the base map
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.GeoPlot$bootLayers()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.GeoPlot-bootQuadrants"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-bootQuadrants}{}}}
\subsection{Method \code{bootQuadrants()}}{
Loads the Oil & Gas quadrants from file for the base map
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.GeoPlot$bootQuadrants()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.GeoPlot-bootConservationAreas"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-bootConservationAreas}{}}}
\subsection{Method \code{bootConservationAreas()}}{
Loads the Conservation Areas from the database for the base
map.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.GeoPlot$bootConservationAreas(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-MNR.GeoPlot-makeBasePlot"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-makeBasePlot}{}}}
\subsection{Method \code{makeBasePlot()}}{
Generates a base plotly map with optional layers included
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.GeoPlot$makeBasePlot(
...,
with_jncc_layers = TRUE,
with_quadrants = FALSE,
with_conservation_areas = FALSE
)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{...}}{Options to call plotly::plot_ly with}
\item{\code{with_jncc_layers}}{\if{html}{\out{<logical>}} Includes the JNCC base layers if TRUE
(call obj$bootLayers() first)}
\item{\code{with_quadrants}}{\if{html}{\out{<logical>}} Includes the Oil & Gas Quadrants if TRUE
(call obj$bootQuadrants() first)}
\item{\code{with_conservation_areas}}{\if{html}{\out{<logical>}} Includes the Conservation Areas
if TRUE (call obj$bootConservationAreas() first)}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.GeoPlot-boundMap"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-boundMap}{}}}
\subsection{Method \code{boundMap()}}{
Bounds a mapbox map to a specific area and zoom
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{MNR.GeoPlot$boundMap(
p,
c_lat = 56,
c_lon = -5.5,
zoom = 3.5,
xmin = -25,
ymin = 45,
xmax = 5,
ymax = 65
)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{p}}{A plotly mapbox map object}
\item{\code{c_lat}}{\if{html}{\out{<numeric>}} Center latitude}
\item{\code{c_lon}}{\if{html}{\out{<numeric>}} Center longitude}
\item{\code{zoom}}{\if{html}{\out{<numeric>}} A mapbox zoom level}
\item{\code{xmin}}{\if{html}{\out{<numeric>}} Minimum longitude to bound with}
\item{\code{ymin}}{\if{html}{\out{<numeric>}} Minimum latitude to bound with}
\item{\code{xmax}}{\if{html}{\out{<numeric>}} Maximum longitude to bound with}
\item{\code{ymax}}{\if{html}{\out{<numeric>}} Maximum latitude to bound with}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-MNR.GeoPlot-clone"></a>}}
\if{latex}{\out{\hypertarget{method-MNR.GeoPlot-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.GeoPlot$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>}}
}
}
}