rbgm

rbgm-package

<p>Tools for handling network data for Atlantis from box-geometry
model (BGM) files</p>

Facilities for working with Atlantis box-geometry model (BGM)
files. Atlantis is a deterministic, biogeochemical, whole-of-ecosystem model.
Functions are provided to read from BGM files directly, preserving their
internal topology, as well as helper functions to generate spatial data from these
mesh forms. This functionality aims to simplify the creation and modification of box
and geometry as well as the ability to integrate with other data sources.

Michael D. Sumner

Tools for 'Box Geometry Model' (BGM) Files and Topology for the
Atlantis Ecosystem Model

rbgm-package function

<p></p><p>
<ul>
<li><p>read .bgm files and faithfully store all information so it can be round-tripped</p></li>
<li><p>conversion from .bgm forms to Spatial classes (lines and polygons)</p></li>
<li><p>(not yet implemented: write to .bgm)</p></li>
</ul>
</p>

rbgm features


 
<table class="table">
<tr><td><code>bgmfile</code></td><td>read directly from a .bgm file</td></tr>
</table><p></p><p></p>

I. Import


 
<table class="table">
<tr><td><code>boxSpatial</code></td><td>convert boxes to a <code><a href="https://edzer.github.io/sp/reference/SpatialPolygons.html">SpatialPolygonsDataFrame</a></code></td></tr>
<tr><td><code>faceSpatial</code></td><td>convert faces to a <code><a href="https://edzer.github.io/sp/reference/SpatialLines.html">SpatialLinesDataFrame</a></code></td></tr>
<tr><td><code>boundarySpatial</code></td><td>convert boundary to a single-row <code><a href="https://edzer.github.io/sp/reference/SpatialPolygons.html">SpatialPolygonsDataFrame</a></code></td></tr>
<tr><td><code>nodeSpatial</code></td><td>obtain all vertices as points</td></tr>
<tr><td><code>pointSpatial</code></td><td>obtain all instances of vertices as points</td></tr>
</table><p></p><p></p>

II. Conversion


 
<table class="table">
<tr><td><code>build_dz</code></td><td>Build Atlantis dz Values</td></tr>
</table><p></p><p></p>

III. Miscellaneous

<p><strong>Maintainer</strong>: Michael D. Sumner <a href="/link/mdsumner%40gmail.com?package=rbgm&version=0.2.0" data-mini-rdoc="rbgm::mdsumner@gmail.com">mdsumner@gmail.com</a></p>

Author

Utilities for BGM files for Atlantis — rbgm-package




<ul>
<li><p>read .bgm files and faithfully store all information so it can be round-tripped</p></li>
<li><p>conversion from .bgm forms to Spatial classes (lines and polygons)</p></li>
<li><p>(not yet implemented: write to .bgm)</p></li>
</ul>



 
<table class='table'>
<tr><td><code>bgmfile</code></td><td>read directly from a .bgm file</td></tr>
</table>




 
<table class='table'>
<tr><td><code>boxSpatial</code></td><td>convert boxes to a <code><a href='https://edzer.github.io/sp/reference/SpatialPolygons.html'>SpatialPolygonsDataFrame</a></code></td></tr>
<tr><td><code>faceSpatial</code></td><td>convert faces to a <code><a href='https://edzer.github.io/sp/reference/SpatialLines.html'>SpatialLinesDataFrame</a></code></td></tr>
<tr><td><code>boundarySpatial</code></td><td>convert boundary to a single-row <code><a href='https://edzer.github.io/sp/reference/SpatialPolygons.html'>SpatialPolygonsDataFrame</a></code></td></tr>
<tr><td><code>nodeSpatial</code></td><td>obtain all vertices as points</td></tr>
<tr><td><code>pointSpatial</code></td><td>obtain all instances of vertices as points</td></tr>
</table>




 
<table class='table'>
<tr><td><code>build_dz</code></td><td>Build Atlantis dz Values</td></tr>
</table>



<p><strong>Maintainer</strong>: Michael D. Sumner <a href='mailto:mdsumner@gmail.com'>mdsumner@gmail.com</a></p>

`boxSpatial`	convert boxes to a `SpatialPolygonsDataFrame`
`faceSpatial`	convert faces to a `SpatialLinesDataFrame`
`boundarySpatial`	convert boundary to a single-row `SpatialPolygonsDataFrame`
`nodeSpatial`	obtain all vertices as points
`pointSpatial`	obtain all instances of vertices as points

rbgm-package: Utilities for BGM files for Atlantis

Description

Arguments

rbgm features

I. Import

II. Conversion

III. Miscellaneous

Author

See Also