Commit d9da9efb authored by Blodgett, David L.'s avatar Blodgett, David L.

documentation update

parent f45a43cf
Package: ncdfgeom
Type: Package
Title: 'NetCDF' Geometry and Timeseries
Title: 'NetCDF' Geometry and Time Series
Version: 1.0.0
Date: 2019-06-05
Authors@R: c(person("David", "Blodgett", role = c("aut", "cre"),
email = "dblodgett@usgs.gov"),
person("Luke", "Winslow", role = "ctb"))
Description: Tools to create timeseries and geometry 'NetCDF' files.
Description: Tools to create time series and geometry 'NetCDF' files.
URL: https://code.usgs.gov/water/ncdfgeom
BugReports: https://github.com/USGS-R/ncdfgeom/issues
Imports: RNetCDF, ncmeta, sf, dplyr, methods
......
NetCDF-CF Geometry and Timeseries Tools for R
===
[![Build Status](https://travis-ci.org/USGS-R/ncdfgeom.svg)](https://travis-ci.org/USGS-R/ncdfgeom) [![Coverage Status](https://coveralls.io/repos/github/USGS-R/ncdfgeom/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/ncdfgeom?branch=master)
[![Build Status](https://travis-ci.org/USGS-R/ncdfgeom.svg)](https://travis-ci.org/USGS-R/ncdfgeom) [![Coverage Status](https://coveralls.io/repos/github/USGS-R/ncdfgeom/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/ncdfgeom?branch=master) [![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/ncdfgeom)](https://cran.r-project.org/web/packages/ncdfgeom/index.html) [![CRAN](https://www.r-pkg.org/badges/version/ncdfgeom)](https://cran.r-project.org/web/packages/ncdfgeom/index.html)
`ncdfgeom` reads and writes geometry data (points lines and polygons), attributes of geometries, and time series associated with the geometries in a standards-compliant way.
......@@ -13,16 +13,16 @@ and consider [submitting issues and/or contributions!](https://github.com/USGS-R
## Installation
For the latest version:
ncdfgeom is available via CRAN.
```
install.packages("devtools")
devtools::install_github("USGS-R/ncdfgeom")
install.packages("ncdfgeom")
```
`ncdfgeom` will be released on CRAN in spring/summer 2019. When available on CRAN, installation will be available via:
For the latest development version:
```
install.packages("ncdfgeom")
install.packages("remotes")
remotes::install_github("USGS-R/ncdfgeom")
```
## Contributing
......
This diff is collapsed.
This diff is collapsed.
......@@ -5,12 +5,12 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>NetCDF Geometry and Timeseries • ncdfgeom</title>
<title>'NetCDF' Geometry and Time Series • ncdfgeom</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script><!-- sticky kit --><script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="NetCDF Geometry and Timeseries">
<meta property="og:description" content="Tools to create timeseries and geometry NetCDF files.">
<script src="pkgdown.js"></script><meta property="og:title" content="'NetCDF' Geometry and Time Series">
<meta property="og:description" content="Tools to create time series and geometry 'NetCDF' files.">
<meta name="twitter:card" content="summary">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
......@@ -86,11 +86,11 @@
<div id="installation" class="section level2">
<h2 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h2>
<p>For the latest version:</p>
<pre><code><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages("devtools")
devtools::install_github("USGS-R/ncdfgeom")</a></code></pre>
<p><code>ncdfgeom</code> will be released on CRAN in spring/summer 2019. When available on CRAN, installation will be available via:</p>
<p>ncdfgeom is available via CRAN.</p>
<pre><code><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages("ncdfgeom")</a></code></pre>
<p>For the latest development version:</p>
<pre><code><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages("remotes")
remotes::install_github("USGS-R/ncdfgeom")</a></code></pre>
</div>
<div id="contributing" class="section level2">
<h2 class="hasAnchor">
......@@ -124,6 +124,8 @@ devtools::install_github("USGS-R/ncdfgeom")</a></code></pre>
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Download from CRAN at <br><a href="https://cloud.r-project.org/package=ncdfgeom">https://​cloud.r-project.org/​package=ncdfgeom</a>
</li>
<li>Report a bug at <br><a href="https://github.com/USGS-R/ncdfgeom/issues">https://​github.com/​USGS-R/​ncdfgeom/​issues</a>
</li>
</ul>
......@@ -131,8 +133,7 @@ devtools::install_github("USGS-R/ncdfgeom")</a></code></pre>
<div class="license">
<h2>License</h2>
<ul class="list-unstyled">
<li>file <a href="LICENSE-text.html">LICENSE</a>
</li>
<li>CC0</li>
</ul>
</div>
<div class="developers">
......@@ -148,6 +149,8 @@ devtools::install_github("USGS-R/ncdfgeom")</a></code></pre>
<ul class="list-unstyled">
<li><a href="https://travis-ci.org/USGS-R/ncdfgeom"><img src="https://travis-ci.org/USGS-R/ncdfgeom.svg" alt="Build Status"></a></li>
<li><a href="https://coveralls.io/github/USGS-R/ncdfgeom?branch=master"><img src="https://coveralls.io/repos/github/USGS-R/ncdfgeom/badge.svg?branch=master" alt="Coverage Status"></a></li>
<li><a href="https://cran.r-project.org/web/packages/ncdfgeom/index.html"><img src="https://cranlogs.r-pkg.org/badges/grand-total/ncdfgeom" alt="CRAN Downloads"></a></li>
<li><a href="https://cran.r-project.org/web/packages/ncdfgeom/index.html"><img src="https://www.r-pkg.org/badges/version/ncdfgeom" alt="CRAN"></a></li>
</ul>
</div>
</div>
......
......@@ -93,7 +93,7 @@ Any columns of class date will be converted to character." />
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/geometry.html">Reading and Writing Geometry</a>
<a href="../articles/geometry.html">Reading and Writing NetCDF-CF Geometry</a>
</li>
<li>
<a href="../articles/timeseries.html">Reading and Writing Timeseries</a>
......@@ -168,8 +168,10 @@ If adding to a file, it must already have the named instance dimension.</p></td>
<span class='no'>example_file</span> <span class='kw'>&lt;-</span><span class='fu'>write_attribute_data</span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/tempfile'>tempfile</a></span>(), <span class='no'>sample_data</span>,
<span class='kw'>units</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/rep'>rep</a></span>(<span class='st'>"unknown"</span>, <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/nrow'>ncol</a></span>(<span class='no'>sample_data</span>)))
<span class='no'>ncdump</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system'>system</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/paste'>paste</a></span>(<span class='st'>"ncdump -h"</span>, <span class='no'>example_file</span>), <span class='kw'>intern</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/cat'>cat</a></span>(<span class='no'>ncdump</span> ,<span class='kw'>sep</span> <span class='kw'>=</span> <span class='st'>"\n"</span>)</div><div class='output co'>#&gt; netcdf file82435852fa6 {
<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/try'>try</a></span>({
<span class='no'>ncdump</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system'>system</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/paste'>paste</a></span>(<span class='st'>"ncdump -h"</span>, <span class='no'>example_file</span>), <span class='kw'>intern</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/cat'>cat</a></span>(<span class='no'>ncdump</span> ,<span class='kw'>sep</span> <span class='kw'>=</span> <span class='st'>"\n"</span>)
}, <span class='kw'>silent</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='output co'>#&gt; netcdf file2ee82d269a3e {
#&gt; dimensions:
#&gt; instance = 100 ;
#&gt; char = 12 ;
......
......@@ -169,8 +169,10 @@ list of variables that should be related to the geometries.</p></td>
<span class='no'>hucPolygons_nc</span> <span class='kw'>&lt;-</span> <span class='kw pkg'>ncdfgeom</span><span class='kw ns'>::</span><span class='fu'><a href='https://www.rdocumentation.org/packages/ncdfgeom/topics/write_geometry'>write_geometry</a></span>(<span class='kw'>nc_file</span><span class='kw'>=</span><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/tempfile'>tempfile</a></span>(),
<span class='kw'>geom_data</span> <span class='kw'>=</span> <span class='no'>hucPolygons</span>)
<span class='no'>ncdump</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system'>system</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/paste'>paste</a></span>(<span class='st'>"ncdump -h"</span>, <span class='no'>hucPolygons_nc</span>), <span class='kw'>intern</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/cat'>cat</a></span>(<span class='no'>ncdump</span> ,<span class='kw'>sep</span> <span class='kw'>=</span> <span class='st'>"\n"</span>)</div><div class='output co'>#&gt; netcdf fileee7d62399989 {
<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/try'>try</a></span>({
<span class='no'>ncdump</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system'>system</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/paste'>paste</a></span>(<span class='st'>"ncdump -h"</span>, <span class='no'>hucPolygons_nc</span>), <span class='kw'>intern</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/cat'>cat</a></span>(<span class='no'>ncdump</span> ,<span class='kw'>sep</span> <span class='kw'>=</span> <span class='st'>"\n"</span>)
}, <span class='kw'>silent</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='output co'>#&gt; netcdf file2ee81bc8b0ef {
#&gt; dimensions:
#&gt; instance = 2 ;
#&gt; char = 38 ;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment