Skip to content

Commit

Permalink
small additions to README:
Browse files Browse the repository at this point in the history
- add tar_terra_sds/tar_terra_tiles
- add example repos, demo-geotargets, and icebreaker
- remove note on development - it is currently maturing
  • Loading branch information
njtierney committed Dec 18, 2024
1 parent 3f8f1da commit 36ecb15
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 24 deletions.
13 changes: 7 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,16 @@ We currently provide support for the `terra` package with `targets`. Below we sh
- `tar_terra_rast()`
- `tar_terra_vect()`
- `tar_terra_sprc()`
- `tar_terra_sds()`
- `tar_tera_tiles()`
- `tar_stars()`

You would use these in place of `tar_target()` in your targets pipeline, when you are doing work with `terra` raster, vector, or raster collection data.
You would use these in place of `tar_target()` in your targets pipeline, e.g., when you are doing work with `terra` raster, vector, or raster collection data.

If you would like to see and download working examples for yourself, see the repo, [demo-geotargets](https://github.com/njtierney/demo-geotargets).
If you would like to see and download working examples for yourself, see the repos:

- [demo-geotargets](https://github.com/njtierney/demo-geotargets)
- [icebreaker](https://github.com/njtierney/icebreaker)

## `tar_terra_rast()`: targets with terra rasters

Expand Down Expand Up @@ -191,10 +196,6 @@ tar_dir({ # tar_dir() runs code from a temporary directory.

Please note that the geotargets project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

## A note on development

`geotargets` is still undergoing development. We currently consider the extensions with `terra` maturing and approaching stability. We would love for people to use the package to kick the tyres. We are using it in our own work, but want users to know that the API could change in subtle or breaking ways.

## Acknowledgements

Logo design by Hubert Hałun at Appsilon.
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,19 @@ Below we show three examples of target factories:
- `tar_terra_rast()`
- `tar_terra_vect()`
- `tar_terra_sprc()`
- `tar_terra_sds()`
- `tar_tera_tiles()`
- `tar_stars()`

You would use these in place of `tar_target()` in your targets pipeline,
when you are doing work with `terra` raster, vector, or raster
e.g., when you are doing work with `terra` raster, vector, or raster
collection data.

If you would like to see and download working examples for yourself, see
the repo,
[demo-geotargets](https://github.com/njtierney/demo-geotargets).
the repos:

- [demo-geotargets](https://github.com/njtierney/demo-geotargets)
- [icebreaker](https://github.com/njtierney/icebreaker)

## `tar_terra_rast()`: targets with terra rasters

Expand Down Expand Up @@ -101,8 +105,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, 7.992 kilobytes]
#> ▶ ended pipeline [0.081 seconds]
#> ● completed target terra_rast_example [0.008 seconds, 7.992 kilobytes]
#> ▶ ended pipeline [0.064 seconds]
#> class : SpatRaster
#> dimensions : 90, 95, 1 (nrow, ncol, nlyr)
#> resolution : 0.008333333, 0.008333333 (x, y)
Expand Down Expand Up @@ -143,8 +147,8 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
x
})
#> ▶ dispatched target terra_vect_example
#> ● completed target terra_vect_example [0.021 seconds, 117.622 kilobytes]
#> ▶ ended pipeline [0.059 seconds]
#> ● completed target terra_vect_example [0.017 seconds, 117.622 kilobytes]
#> ▶ ended pipeline [0.054 seconds]
#> class : SpatVector
#> geometry : polygons
#> dimensions : 12, 6 (geometries, attributes)
Expand Down Expand Up @@ -190,8 +194,8 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
x
})
#> ▶ dispatched target raster_elevs
#> ● completed target raster_elevs [0.056 seconds, 36.423 kilobytes]
#> ▶ ended pipeline [0.11 seconds]
#> ● completed target raster_elevs [0.065 seconds, 36.423 kilobytes]
#> ▶ ended pipeline [0.119 seconds]
#> class : SpatRasterCollection
#> length : 2
#> nrow : 90, 115
Expand Down Expand Up @@ -223,7 +227,7 @@ tar_dir({ # tar_dir() runs code from a temporary directory.
})
#> ▶ dispatched target test_stars
#> ● completed target test_stars [0.018 seconds, 49.9 kilobytes]
#> ▶ ended pipeline [0.06 seconds]
#> ▶ ended pipeline [0.059 seconds]
#> stars object with 2 dimensions and 1 attribute
#> attribute(s):
#> Min. 1st Qu. Median Mean 3rd Qu. Max.
Expand All @@ -241,14 +245,6 @@ Code of
Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.

## A note on development

`geotargets` is still undergoing development. We currently consider the
extensions with `terra` maturing and approaching stability. We would
love for people to use the package to kick the tyres. We are using it in
our own work, but want users to know that the API could change in subtle
or breaking ways.

## Acknowledgements

Logo design by Hubert Hałun at Appsilon.

0 comments on commit 36ecb15

Please sign in to comment.