Skip to content

Commit

Permalink
Merge pull request #91 from dblodgett-usgs/main
Browse files Browse the repository at this point in the history
document
  • Loading branch information
dblodgett-usgs authored Nov 14, 2023
2 parents 9b5fb04 + 15b9439 commit 914bdd8
Show file tree
Hide file tree
Showing 35 changed files with 2,114 additions and 2,495 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
.RData
.DS_Store
*.Rproj

CRAN-SUBMISSION
7 changes: 3 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
Package: ncdfgeom
Type: Package
Title: 'NetCDF' Geometry and Time Series
Version: 1.1.4
Date: 2022-11-06
Version: 1.1.5
Authors@R: c(person("David", "Blodgett", role = c("aut", "cre"),
email = "[email protected]"),
person("Luke", "Winslow", role = "ctb"))
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
BugReports: https://github.com/DOI-USGS/ncdfgeom/issues
Imports: RNetCDF, ncmeta, sf, dplyr, methods, stars
Depends:
R (>= 3.5)
Suggests: testthat, knitr, rmarkdown, pkgdown, geoknife, ncdf4, jsonlite, areal
License: CC0
Encoding: UTF-8
VignetteBuilder: knitr
RoxygenNote: 7.2.1
RoxygenNote: 7.2.3
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
1.1.5
==========
* update URLs for new repository.

ncdfgeom 1.1.1
==========
* Updates to read and write timeseries DSG. Should be backwards compatible.
Expand Down
7 changes: 0 additions & 7 deletions R/0_ncdfgeom.R
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@

.onAttach <- function(libname, pkgname) {
packageStartupMessage("****Support Package****
This package is a USGS-R Support package.
see: https://owi.usgs.gov/R/packages.html#support")
}

pkg.env <- new.env()
pkg.env$multi_val <- 0
pkg.env$hole_val <- 1
Expand Down
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
NetCDF-CF Geometry and Timeseries Tools for R
===
![R-CMD-check](https://github.com/usgs-r/ncdfgeom/workflows/R-CMD-check/badge.svg) [![codecov](https://codecov.io/gh/usgs-r/ncdfgeom/branch/master/graph/badge.svg?token=5c1L38yK5q)](https://app.codecov.io/gh/usgs-r/ncdfgeom) [![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/ncdfgeom)](https://cran.r-project.org/package=ncdfgeom) [![CRAN](https://www.r-pkg.org/badges/version/ncdfgeom)](https://cran.r-project.org/package=ncdfgeom)
<!---
![R-CMD-check](https://github.com/doi-usgs/ncdfgeom/workflows/R-CMD-check/badge.svg) [![codecov](https://codecov.io/gh/doi-usgs/ncdfgeom/branch/master/graph/badge.svg?token=5c1L38yK5q)](https://app.codecov.io/gh/doi-usgs/ncdfgeom)
--->
[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/ncdfgeom)](https://cran.r-project.org/package=ncdfgeom) [![CRAN](https://www.r-pkg.org/badges/version/ncdfgeom)](https://cran.r-project.org/package=ncdfgeom)

`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.

It implements the NetCDF-CF Spatial Geometries specification and the timeSeries feature type of the [Discrete Sampling Geometry](http://cfconventions.org/cf-conventions/cf-conventions.html#discrete-sampling-geometries) NetCDF-CF specification.

**Visit the [`pkgdown` site](https://usgs-r.github.io/ncdfgeom/articles/ncdfgeom.html) for a complete overview of the package.**
**Visit the [`pkgdown` site](https://doi-usgs.github.io/ncdfgeom/articles/ncdfgeom.html) for a complete overview of the package.**

Given that this package is fairly new and in active development, please test it out
and consider [submitting issues and/or contributions!](https://github.com/USGS-R/ncdfgeom/issues)
and consider [submitting issues and/or contributions!](https://github.com/DOI-USGS/ncdfgeom/issues)

## Installation

Expand All @@ -22,7 +25,7 @@ install.packages("ncdfgeom")
For the latest development version:
```
install.packages("remotes")
remotes::install_github("USGS-R/ncdfgeom")
remotes::install_github("DOI-USGS/ncdfgeom")
```

## Contributing
Expand All @@ -35,13 +38,6 @@ First, thanks for considering a contribution! I hope to make this package a comm
1. Please follow the typical github fork - pull-request workflow.
1. Make sure you use roxygen and run Check before contributing. More on this front as the package matures.

## Package Status

[![status](https://img.shields.io/badge/USGS-Support-yellow.svg)](https://owi.usgs.gov/R/packages.html#support)

This package is considered a 'support' package. For more information, see:
[https://owi.usgs.gov/R/packages.html#support](https://owi.usgs.gov/R/packages.html#support)

## Disclaimer
This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the [official USGS copyright policy](https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits#copyright/ "official USGS copyright policy")

Expand Down
4 changes: 2 additions & 2 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
* local windows

## Comment
* sf bug has been fixed.
* addresses failing M1 mac test: builder here https://mac.r-project.org/macbuilder/results/1667741785-c6949eb7ff801ac7/
* change urls to new repository.
* removed use of deprecated pillars print argument.
121 changes: 38 additions & 83 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 914bdd8

Please sign in to comment.