Skip to content

Commit

Permalink
various tweaks to get ready for rOpenSci review
Browse files Browse the repository at this point in the history
- update URL in DESCRIPTION
- update README badge Project status to "Active"
- add "pkgcheck" badge in README
- add return value to tar_stars and tar_terra_tiles
- remove unused "library(dplyr)" from vignette
  • Loading branch information
njtierney committed Nov 29, 2024
1 parent 6193d49 commit 31cda10
Show file tree
Hide file tree
Showing 13 changed files with 246 additions and 268 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ Suggests:
testthat (>= 3.0.0),
fs
Config/testthat/edition: 3
URL: https://github.com/njtierney/geotargets, https://njtierney.github.io/geotargets/
URL: https://github.com/njtierney/geotargets, http://geotargets.njtierney.com
BugReports: https://github.com/njtierney/geotargets/issues
VignetteBuilder: knitr
2 changes: 1 addition & 1 deletion R/tar-stars.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
#' [stars::read_ncdf()]? Default: `FALSE`. Only supported for
#' `driver="netCDF"`.
#'@param ... Additional arguments not yet used.
#'
#' @returns target class "tar_stem" for use in a target pipeline
#'@inheritParams targets::tar_target
#'
#'@note The `iteration` argument is unavailable because it is hard-coded to
Expand Down
1 change: 1 addition & 0 deletions R/tar_terra_tiles.R
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ tar_terra_tiles_raw <- function(
#'
#' @note While this may have general use, it was created primarily for use
#' within [tar_terra_tiles()].
#' @return SpatRaster
#' @author Eric Scott
#' @export
#' @examples
Expand Down
3 changes: 2 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ knitr::opts_chunk$set(
# geotargets <a href="https://njtierney.github.io/geotargets/"><img src="man/figures/logo.svg" alt="geotargets website" align="right" height="139"/></a>

<!-- badges: start -->
[![Project Status: WIPInitial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Project Status: ActiveThe project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R Targetopia](https://img.shields.io/badge/R_Targetopia-member-blue?style=flat&labelColor=gray)](https://wlandau.github.io/targetopia/)
[![R-CMD-check](https://github.com/njtierney/geotargets/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/njtierney/geotargets/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/njtierney/geotargets/branch/master/graph/badge.svg)](https://app.codecov.io/gh/njtierney/geotargets?branch=master)
[![pkgcheck](https://github.com/njtierney/geotargets/workflows/pkgcheck/badge.svg)](https://github.com/njtierney/geotargets/actions?query=workflow%3Apkgcheck)
<!-- badges: end -->

`geotargets` extends [`targets`](https://github.com/ropensci/targets) to work with geospatial data formats, such as rasters and vectors (e.g., shapefiles). Currently we support raster and vector formats for the [`terra`](https://github.com/rspatial/terra) package
Expand Down
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# geotargets <a href="https://njtierney.github.io/geotargets/"><img src="man/figures/logo.png" alt="geotargets website" align="right" height="139"/></a>
# geotargets <a href="https://njtierney.github.io/geotargets/"><img src="man/figures/logo.svg" alt="geotargets website" align="right" height="139"/></a>

<!-- badges: start -->

[![Project Status: WIPInitial development is in progress, but there
has not yet been a stable, usable release suitable for the
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Project Status: ActiveThe project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R
Targetopia](https://img.shields.io/badge/R_Targetopia-member-blue?style=flat&labelColor=gray)](https://wlandau.github.io/targetopia/)
[![R-CMD-check](https://github.com/njtierney/geotargets/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/njtierney/geotargets/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/njtierney/geotargets/branch/master/graph/badge.svg)](https://app.codecov.io/gh/njtierney/geotargets?branch=master)
[![pkgcheck](https://github.com/njtierney/geotargets/workflows/pkgcheck/badge.svg)](https://github.com/njtierney/geotargets/actions?query=workflow%3Apkgcheck)
<!-- badges: end -->

`geotargets` extends [`targets`](https://github.com/ropensci/targets) to
Expand Down Expand Up @@ -100,8 +101,8 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
x
})
#> ▶ dispatched target terra_rast_example
#> ● completed target terra_rast_example [0.018 seconds]
#> ▶ ended pipeline [0.168 seconds]
#> ● completed target terra_rast_example [0.006 seconds, 7.992 kilobytes]
#> ▶ ended pipeline [0.061 seconds]
#> class : SpatRaster
#> dimensions : 90, 95, 1 (nrow, ncol, nlyr)
#> resolution : 0.008333333, 0.008333333 (x, y)
Expand Down Expand Up @@ -139,8 +140,8 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
x
})
#> ▶ dispatched target terra_vect_example
#> ● completed target terra_vect_example [0.037 seconds]
#> ▶ ended pipeline [0.183 seconds]
#> ● completed target terra_vect_example [0.014 seconds, 117.622 kilobytes]
#> ▶ ended pipeline [0.052 seconds]
#> class : SpatVector
#> geometry : polygons
#> dimensions : 12, 6 (geometries, attributes)
Expand Down Expand Up @@ -187,11 +188,8 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
x
})
#> ▶ dispatched target raster_elevs
#> ● completed target raster_elevs [0.128 seconds]
#> ▶ ended pipeline [0.266 seconds]
#> Warning message:
#> [rast] skipped sub-datasets (see 'describe(sds=TRUE)'):
#> /private/var/folders/wr/by_lst2d2fngf67mknmgf4340000gn/T/RtmpjrYMSQ/targets_80c86866e24b/_targets/scratch/raster_elevs
#> ● completed target raster_elevs [0.055 seconds, 36.423 kilobytes]
#> ▶ ended pipeline [0.11 seconds]
#> class : SpatRasterCollection
#> length : 2
#> nrow : 90, 115
Expand Down Expand Up @@ -222,11 +220,8 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
x
})
#> ▶ dispatched target test_stars
#> ● completed target test_stars [0.031 seconds]
#> ▶ ended pipeline [0.139 seconds]
#> Warning message:
#> In CPL_write_gdal(mat, file, driver, options, type, dims, from, :
#> GDAL Message 6: creation option '' is not formatted with the key=value format
#> ● completed target test_stars [0.011 seconds, 49.9 kilobytes]
#> ▶ ended pipeline [0.052 seconds]
#> stars object with 2 dimensions and 1 attribute
#> attribute(s):
#> Min. 1st Qu. Median Mean 3rd Qu. Max.
Expand Down
3 changes: 3 additions & 0 deletions man/set_window.Rd

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

81 changes: 40 additions & 41 deletions man/tar_stars.Rd

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

78 changes: 37 additions & 41 deletions man/tar_terra_rast.Rd

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

Loading

0 comments on commit 31cda10

Please sign in to comment.