updates readme, closes #28

.Rbuildignore

@@ -11,3 +11,4 @@
 ^_targets_packages\.R$
 ^_targets\.Rmd$
 ^_targets\.yaml$
+^CODE_OF_CONDUCT\.md$

CODE_OF_CONDUCT.md

@@ -0,0 +1,126 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+ community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+ any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+ without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at nicholas.tierney@gmail.com. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

README.Rmd

@@ -22,7 +22,24 @@ knitr::opts_chunk$set(
 [![Codecov test coverage](https://codecov.io/gh/njtierney/geotargets/branch/master/graph/badge.svg)](https://app.codecov.io/gh/njtierney/geotargets?branch=master)
 <!-- badges: end -->
 
-The goal of geotargets is to extend targets to work with geospatial data, like shapefiles and rasters.
+`geotargets` extends targets to work with geospatial data formats, such as rasters and vectors (e.g., shapefiles). 
+
+A relatively common gotcha moment when using popular libraries like `terra` with targets is running into erros with read and write. Due to the limitations that come with the underlying C++ implementation in the `terra` library, there are specific ways to write and read these objects. See `?terra` for details. `geotargets` helps handle these write and read steps, so you don't have to worry about them and can use targets as you are used to.
+
+In essence, if you've ever come across the error:
+
+```
+Error in .External(list(name = "CppMethod__invoke_notvoid", address = <pointer: 0x0>, : 
+ NULL value passed as symbol address
+```
+
+or 
+
+```
+Error: external pointer is not valid
+```
+
+When trying to read in a geospatial raster or vector in targets, then this is for you :)
 
 ## Installation
 
@@ -32,11 +49,74 @@ You can install the development version of geotargets like so:
 remotes::install_github("njtierney/geotargets")
 ```
 
-## Package still under development
+## A note on development
+
+`geotargets` is still undergoing development, and we would love for people to use the package to kick the tyres. We are using it in our own work, but feel it is appropriate that users use the package with the understanding the API could change in subtle or breaking ways.
+
+# Examples
+
+Below we show two examples of target factories:
+
+- `tar_terra_rast()`
+- `tar_terra_vect()`
+
+You would use these in place of `tar_target()` in your targets pipeline, when you are doing work with terra raster or terra vector data.
+
+It is a bit tricky to implement targets workflows in a README, but if you would like to see and download working examples for yourself, see the repo, [demo-geotargets](https://github.com/njtierney/demo-geotargets)
+
+## `tar_terra_rast()`: targets with terra rasters
+
+```{r}
+#| label: tar-terra-rast
+#| eval: false
+library(targets)
+tar_dir({ # tar_dir() runs code from a temporary directory.
+ tar_script({
+ library(targets)
+ library(geotargets)
+ list(
+ tar_terra_rast(
+ terra_rast_example,
+ system.file("ex/elev.tif", package = "terra") |> terra::rast()
+ )
+ )
+ })
+ tar_make()
+ x <- tar_read(terra_rast_example)
+ x
+})
+```
+
 
-Currently geotargets provides:
+## `tar_terra_vect()`: targets with terra vectors
+
+```{r}
+#| label: tar-terra-vect
+#| eval: false
+tar_dir({ # tar_dir() runs code from a temporary directory.
+ tar_script({
+ library(geotargets)
+ lux_area <- function(projection = "EPSG:4326") {
+ terra::project(
+ terra::vect(system.file("ex", "lux.shp",
+ package = "terra"
+ )),
+ projection
+ )
+ }
+ list(
+ tar_terra_vect(
+ terra_vect_example,
+ lux_area()
+ )
+ )
+ })
+ tar_make()
+ x <- tar_read(terra_rast_example)
+ x
+})
+```
 
-- `tar_terra_rast`
-- `tar_terra_vect`
+## Code of Conduct
 
-These are under active development.
+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.

README.md

@@ -15,8 +15,28 @@ Targetopia](https://img.shields.io/badge/R_Targetopia-member-blue?style=flat&lab
 coverage](https://codecov.io/gh/njtierney/geotargets/branch/master/graph/badge.svg)](https://app.codecov.io/gh/njtierney/geotargets?branch=master)
 <!-- badges: end -->
 
-The goal of geotargets is to extend targets to work with geospatial
-data, like shapefiles and rasters.
+`geotargets` extends targets to work with geospatial data formats, such
+as rasters and vectors (e.g., shapefiles).
+
+A relatively common gotcha moment when using popular libraries like
+`terra` with targets is running into erros with read and write. Due to
+the limitations that come with the underlying C++ implementation in the
+`terra` library, there are specific ways to write and read these
+objects. See `?terra` for details. `geotargets` helps handle these write
+and read steps, so you don’t have to worry about them and can use
+targets as you are used to.
+
+In essence, if you’ve ever come across the error:
+
+ Error in .External(list(name = "CppMethod__invoke_notvoid", address = <pointer: 0x0>, : 
+  NULL value passed as symbol address
+
+or
+
+ Error: external pointer is not valid
+
+When trying to read in a geospatial raster or vector in targets, then
+this is for you :)
 
 ## Installation
 
@@ -26,11 +46,79 @@ You can install the development version of geotargets like so:
 remotes::install_github("njtierney/geotargets")
 ```
 
-## Package still under development
+## A note on development
+
+`geotargets` is still undergoing development, and we would love for
+people to use the package to kick the tyres. We are using it in our own
+work, but feel it is appropriate that users use the package with the
+understanding the API could change in subtle or breaking ways.
+
+# Examples
+
+Below we show two examples of target factories:
+
+- `tar_terra_rast()`
+- `tar_terra_vect()`
 
-Currently geotargets provides:
+You would use these in place of `tar_target()` in your targets pipeline,
+when you are doing work with terra raster or terra vector data.
+
+It is a bit tricky to implement targets workflows in a README, but if
+you would like to see and download working examples for yourself, see
+the repo,
+[demo-geotargets](https://github.com/njtierney/demo-geotargets)
+
+## `tar_terra_rast()`: targets with terra rasters
+
+``` r
+library(targets)
+tar_dir({ # tar_dir() runs code from a temporary directory.
+ tar_script({
+ library(targets)
+ library(geotargets)
+ list(
+ tar_terra_rast(
+ terra_rast_example,
+ system.file("ex/elev.tif", package = "terra") |> terra::rast()
+ )
+ )
+ })
+ tar_make()
+ x <- tar_read(terra_rast_example)
+ x
+})
+```
+
+## `tar_terra_vect()`: targets with terra vectors
+
+``` r
+tar_dir({ # tar_dir() runs code from a temporary directory.
+ tar_script({
+ library(geotargets)
+ lux_area <- function(projection = "EPSG:4326") {
+ terra::project(
+ terra::vect(system.file("ex", "lux.shp",
+ package = "terra"
+ )),
+ projection
+ )
+ }
+ list(
+ tar_terra_vect(
+ terra_vect_example,
+ lux_area()
+ )
+ )
+ })
+ tar_make()
+ x <- tar_read(terra_rast_example)
+ x
+})
+```
 
-- `tar_terra_rast`
-- `tar_terra_vect`
+## Code of Conduct
 
-These are under active development.
+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.