Skip to content

Commit

Permalink
1.6.10
Browse files Browse the repository at this point in the history
  • Loading branch information
dblodgett-usgs committed Dec 15, 2022
1 parent 1d0812d commit 321be0c
Show file tree
Hide file tree
Showing 13 changed files with 48 additions and 42 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ code.json
.github
Dockerfile
^CRAN-SUBMISSION$
temp.R
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,8 @@ nbproject/

doc
Meta
.Renviron
.Renviron

CRAN-SUBMISSION

temp.R
9 changes: 4 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: geoknife
Type: Package
Title: Web-Processing of Large Gridded Datasets
Version: 1.6.9
Version: 1.6.10
Authors@R: c( person("Jordan", "Read", role = c("aut"),
email = "[email protected]"),
person("Jordan", "Walker", role = c("aut"),
Expand All @@ -24,8 +24,8 @@ Description: Processes gridded datasets found on the U.S. Geological Survey
hosted on the Internet. The package provides access to several data subset and
summarization algorithms that are available on remote web processing servers (Read et al. (2015) <doi:10.1111/ecog.01880>).
License: CC0
URL: https://github.com/USGS-R/geoknife
BugReports: https://github.com/USGS-R/geoknife/issues
URL: https://github.com/DOI-USGS/geoknife
BugReports: https://github.com/DOI-USGS/geoknife/issues
Copyright: This software is in the public domain because it contains materials
that originally came from the United States Geological Survey, an agency of
the United States Department of Interior.
Expand All @@ -49,9 +49,8 @@ Suggests:
dplyr,
rasterVis,
ggplot2,
rgdal,
sp,
raster
VignetteBuilder: knitr
Encoding: UTF-8
RoxygenNote: 7.2.1
RoxygenNote: 7.2.2
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
geoknife 1.6.10
==========
* updates urls to reflect new repository
* remove suggests on rgdal

geoknife 1.6.9
==========
* fixed documentation with duplicate "..." parameter.
Expand Down
4 changes: 2 additions & 2 deletions R/result.R
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ algorithmParseDetails <- function(jobID){

if (!algorithm.name %in% names(function.handlers)){
stop('parser for ',algorithm.name,
' not currently supported. Create an issue to suggest it: https://github.com/USGS-R/geoknife/issues/new', call. = FALSE)
' not currently supported. Create an issue to suggest it: https://github.com/DOI-USGS/geoknife/issues/new', call. = FALSE)
}
parse.details <- c(function.handlers[[algorithm.name]], 'delimiter'=outputDelimiter(jobID))
return(parse.details)
Expand All @@ -80,7 +80,7 @@ outputDelimiter <- function(jobID){
doc <- xml2::read_html(resp)
type <- xml2::xml_attr(xml2::xml_find_all(doc,"//reference[@mimetype]")[[1]],'mimetype')
if (!type %in% names(delimiters)){
stop('output ',type, ' not currently supported. Create an issue to suggest it: https://github.com/USGS-R/geoknife/issues/new', call. = FALSE)
stop('output ',type, ' not currently supported. Create an issue to suggest it: https://github.com/DOI-USGS/geoknife/issues/new', call. = FALSE)
}
return(delimiters[[type]])
}
Expand Down
16 changes: 8 additions & 8 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ output:
---
# `geoknife` package version `r packageVersion('geoknife')`

[![Build status](https://ci.appveyor.com/api/projects/status/0iacmg82mp50426o/branch/master)](https://ci.appveyor.com/project/jread-usgs/geoknife/branch/master)
![R-CMD-check](https://github.com/usgs-r/geoknife/workflows/R-CMD-check/badge.svg) [![codecov](https://codecov.io/gh/usgs-r/geoknife/branch/master/graph/badge.svg)](https://codecov.io/gh/usgs-r/geoknife)
<!-- ![R-CMD-check](https://github.com/doi-usgs/geoknife/workflows/R-CMD-check/badge.svg) [![codecov](https://codecov.io/gh/doi-usgs/geoknife/branch/master/graph/badge.svg)](https://codecov.io/gh/doi-usgs/geoknife) -->
[![CRAN](https://www.r-pkg.org/badges/version/geoknife)](https://cran.r-project.org/package=geoknife)
[![Download Count](http://cranlogs.r-pkg.org/badges/geoknife)](https://cran.r-project.org/package=geoknife)
[![status](https://img.shields.io/badge/USGS-Core-green.svg)](https://owi.usgs.gov/R/packages.html#core)

Tools for geo-web processing of gridded data via the [Geo Data Portal](https://labs.waterdata.usgs.gov/gdp_web/ "Geo Data Portal"). `geoknife` slices up gridded data according to overlap with irregular features, such as watersheds, lakes, points, etc. The result is subsetted data in plain text, NetCDF, geotiff or other formats.
<p align="center">
<img src="http://usgs-r.github.io/images/geoknife.png" alt="GDP" align="center">
<img src="http://doi-usgs.github.io/images/geoknife.png" alt="GDP" align="center">
</p>
<br />

Expand All @@ -35,27 +35,27 @@ install.packages("geoknife")
Or to install the current development version of the package:
```{r, eval=FALSE}
install.packages("remotes")
remotes::install_github('USGS-R/geoknife')
remotes::install_github('DOI-USGS/geoknife')
```

### Reporting bugs

Please consider reporting bugs and asking questions on the Issues page:
[https://github.com/USGS-R/geoknife/issues](https://github.com/USGS-R/geoknife/issues)
[https://github.com/DOI-USGS/geoknife/issues](https://github.com/DOI-USGS/geoknife/issues)

Follow `@USGS_R` on Twitter for updates on USGS R packages:

[![Twitter Follow](https://img.shields.io/twitter/follow/USGS_R.svg?style=social&label=Follow%20USGS_R)](https://twitter.com/USGS_R)

### Code of Conduct

We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](https://github.com/USGS-R/geoknife/blob/master/CONDUCT.md) for more information.
We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](https://github.com/DOI-USGS/geoknife/blob/master/CONDUCT.md) for more information.

### Package Support

The Water Mission Area of the USGS supports the development and maintenance of `geoknife` through September 2018, and most likely further into the future. Resources are available primarily for maintenance and responding to user questions. Priorities on the development of new features are determined by the `geoknife` development team.

[![USGS](http://usgs-r.github.io/images/usgs.png)](https://www.usgs.gov/)
[![USGS](http://doi-usgs.github.io/images/usgs.png)](https://www.usgs.gov/)

## `geoknife` overview
The `geoknife` package was created to support web-based geoprocessing of large gridded datasets according to their overlap with landscape (or aquatic/ocean) features that are often irregularly shaped. `geoknife` creates data access and subsequent geoprocessing requests for the USGS's Geo Data Portal to carry out on a web server. The results of these requests are available for download after the processes have been completed. This type of workflow has three main advantages: 1) it allows the user to avoid downloading large datasets, 2) it avoids reinventing the wheel for the creation and optimization of complex geoprocessing algorithms, and 3) computing resources are dedicated elsewhere, so `geoknife` operations do not have much of an impact on a local computer.
Expand Down
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# `geoknife` package version 1.6.9
# `geoknife` package version 1.6.10

[![Build
status](https://ci.appveyor.com/api/projects/status/0iacmg82mp50426o/branch/master)](https://ci.appveyor.com/project/jread-usgs/geoknife/branch/master)
![R-CMD-check](https://github.com/usgs-r/geoknife/workflows/R-CMD-check/badge.svg)
[![codecov](https://codecov.io/gh/usgs-r/geoknife/branch/master/graph/badge.svg)](https://codecov.io/gh/usgs-r/geoknife)
<!-- ![R-CMD-check](https://github.com/doi-usgs/geoknife/workflows/R-CMD-check/badge.svg) [![codecov](https://codecov.io/gh/doi-usgs/geoknife/branch/master/graph/badge.svg)](https://codecov.io/gh/doi-usgs/geoknife) -->

[![CRAN](https://www.r-pkg.org/badges/version/geoknife)](https://cran.r-project.org/package=geoknife)
[![Download
Count](http://cranlogs.r-pkg.org/badges/geoknife)](https://cran.r-project.org/package=geoknife)
[![status](https://img.shields.io/badge/USGS-Core-green.svg)](https://owi.usgs.gov/R/packages.html#core)
Count](http://cranlogs.r-pkg.org/badges/geoknife)](https://cran.r-project.org/package=geoknife)

Tools for geo-web processing of gridded data via the [Geo Data
Portal](https://labs.waterdata.usgs.gov/gdp_web/ "Geo Data Portal").
`geoknife` slices up gridded data according to overlap with irregular
features, such as watersheds, lakes, points, etc. The result is
subsetted data in plain text, NetCDF, geotiff or other formats.
<p align="center">
<img src="http://usgs-r.github.io/images/geoknife.png" alt="GDP" align="center">
<img src="http://doi-usgs.github.io/images/geoknife.png" alt="GDP" align="center">
</p>

<br />
Expand All @@ -30,13 +29,13 @@ Or to install the current development version of the package:

``` r
install.packages("remotes")
remotes::install_github('USGS-R/geoknife')
remotes::install_github('DOI-USGS/geoknife')
```

### Reporting bugs

Please consider reporting bugs and asking questions on the Issues page:
<https://github.com/USGS-R/geoknife/issues>
<https://github.com/DOI-USGS/geoknife/issues>

Follow `@USGS_R` on Twitter for updates on USGS R packages:

Expand All @@ -47,8 +46,8 @@ Follow](https://img.shields.io/twitter/follow/USGS_R.svg?style=social&label=Foll

We want to encourage a warm, welcoming, and safe environment for
contributing to this project. See the [code of
conduct](https://github.com/USGS-R/geoknife/blob/master/CONDUCT.md) for
more information.
conduct](https://github.com/DOI-USGS/geoknife/blob/master/CONDUCT.md)
for more information.

### Package Support

Expand All @@ -59,7 +58,7 @@ maintenance and responding to user questions. Priorities on the
development of new features are determined by the `geoknife` development
team.

[![USGS](http://usgs-r.github.io/images/usgs.png)](https://www.usgs.gov/)
[![USGS](http://doi-usgs.github.io/images/usgs.png)](https://www.usgs.gov/)

## `geoknife` overview

Expand Down Expand Up @@ -131,11 +130,7 @@ times(fabric) <- as.POSIXct(c('2003-01-01','2005-01-01'))

``` r
job <- geoknife(stencil, fabric, wait = TRUE)
```

## Process Accepted

``` r
# use existing convienence functions to check on the job:
check(job)
```
Expand All @@ -144,7 +139,7 @@ check(job)
## [1] "Process successful"
##
## $URL
## [1] "https://labs.waterdata.usgs.gov:443/gdp-process-wps/RetrieveResultServlet?id=79a95bbe-4090-480d-b768-a156ece62ffdOUTPUT"
## [1] "https://labs.waterdata.usgs.gov:443/gdp-process-wps/RetrieveResultServlet?id=5efbd033-6d22-453d-aaac-224b3c1b57f8OUTPUT"
##
## $statusType
## [1] "ProcessSucceeded"
Expand Down
10 changes: 5 additions & 5 deletions code.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
"name": "geoknife",
"organization": "U.S. Geological Survey",
"description": "Processes gridded datasets found on the U.S. Geological Survey Geo Data Portal web application or elsewhere, using a web-enabled workflow that eliminates the need to download and store large datasets that are reliably hosted on the Internet. The package provides access to several data subset and summarization algorithms that are available on remote web processing servers.",
"version": "v1.6.9",
"version": "v1.6.10",
"status": "Development",
"permissions": {
"usageType": "openSource",
"licenses": [
{
"name": "Public Domain, CC0-1.0",
"URL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/-/raw/v1.6.9/LICENSE.md"
"URL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/-/raw/v1.6.10/LICENSE.md"
}
]
},
"homepageURL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/",
"downloadURL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/-/archive/v1.6.9/geoknife-v1.6.9.zip",
"disclaimerURL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/-/raw/v1.6.9/DISCLAIMER.md",
"downloadURL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/-/archive/v1.6.10/geoknife-v1.6.10.zip",
"disclaimerURL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife/-/raw/v1.6.10/DISCLAIMER.md",
"repositoryURL": "https://code.usgs.gov/wma/nhgf/geo-data-portal/geoknife.git",
"vcs": "git",
"laborHours": 500,
Expand All @@ -35,7 +35,7 @@
"email": "[email protected]"
},
"date": {
"metadataLastUpdated": "2022-11-07"
"metadataLastUpdated": "2022-12-14"
}
},
{
Expand Down
5 changes: 3 additions & 2 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Test environments
* local windows
* rhub::check_for_cran w/ defaults

## Comment
* Submission corrects duplicated documentation of "..." parameter.
* replace journal url with doi
* updates urls to reflect new repository
* remove suggests on rgdal
Binary file modified inst/unnamed-chunk-6-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tests/testthat/data/test_webprocess_knife.rds
Binary file not shown.
1 change: 1 addition & 0 deletions tests/testthat/test-webprocess_object.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
context('test modifying webprocess object')

test_that("webprocess object is modified correctly", {
testthat::skip("no public qa")
testthat::skip_on_cran()
wp <- readRDS("data/test_webprocess_knife.rds")
# test setting url also changes util
Expand Down
2 changes: 1 addition & 1 deletion vignettes/geoknife.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ install.packages("geoknife",
Or to install the current development version of the package:
```{r, eval=FALSE}
install.packages("devtools")
devtools::install_github('USGS-R/geoknife')
devtools::install_github('DOI-USGS/geoknife')
```

## getting started
Expand Down

0 comments on commit 321be0c

Please sign in to comment.