From 6213851aa759ff3e7c7a885e89dbcda1a06a2446 Mon Sep 17 00:00:00 2001 From: "Jeff W. Hollister" Date: Fri, 16 Dec 2016 15:44:24 -0500 Subject: [PATCH] draft of materials for JOSS submission. --- .Rbuildignore | 3 +++ .gitignore | 1 + codemeta.json | 30 ++++++++++++++++++++++++++++++ paper.bib | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ paper.md | 29 +++++++++++++++++++++++++++++ 5 files changed, 111 insertions(+) create mode 100644 codemeta.json create mode 100644 paper.bib create mode 100644 paper.md diff --git a/.Rbuildignore b/.Rbuildignore index e1b9f13..450539b 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,6 @@ man-roxygen cran-comments.md ^CONDUCT\.md$ ^cran-comments\.md$ +^paper\.bib$ +^paper\.md$ +^generate\.sh$ diff --git a/.gitignore b/.gitignore index 56e8989..a2d9210 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .DS_Store .V8history .httr-oauth +generate.sh diff --git a/codemeta.json b/codemeta.json new file mode 100644 index 0000000..cbf2c1a --- /dev/null +++ b/codemeta.json @@ -0,0 +1,30 @@ +{ + "@context": "https://raw.githubusercontent.com/mbjones/codemeta/master/codemeta.jsonld", + "@type": "Code", + "author": [ + { + "@id": "0000-0003-1444-9135", + "@type": "Person", + "email": "myrmecocystus@gmail.com", + "name": "Scott Chamberlain", + "affiliation": "rOpenSci" + }, + { + "@id": "0000-0002-9254-9740", + "@type": "Person", + "email": "hollister.jeff@epa.gov", + "name": "Jeffrey W. Hollister", + "affiliation": "US Environmental Protection Agency, Atlantic Ecology Division" + } + ], + "identifier": "", + "codeRepository": "https://github.com/ropensci/lawn", + "datePublished": "2016-12-16", + "dateModified": "2016-12-16", + "dateCreated": "2016-12-16", + "description": "This is an R package to provide access to the Turfjs library in R", + "keywords": "geospatial, javascript, GeoJSON", + "license": "MIT", + "title": "lawn: An R client for Turfjs for Geospatial Analysis", + "version": "v0.3.1" +} \ No newline at end of file diff --git a/paper.bib b/paper.bib new file mode 100644 index 0000000..4f08542 --- /dev/null +++ b/paper.bib @@ -0,0 +1,48 @@ +@online{turfjs, + author = {Herlocker, Morgan}, + title = {Turf: Advanced geospatial analysis for browsers and node}, + year = 2016, + url = {http://turfjs.org/}, + urldate = {2016-12-16} +} + +@Manual{r, + title = {R: A Language and Environment for Statistical Computing}, + author = {{R Core Team}}, + organization = {R Foundation for Statistical Computing}, + address = {Vienna, Austria}, + year = {2016}, + url = {https://www.R-project.org/}, + } + +@book{bivand2013asdar, + author={Bivand, Roger S and Pebesma, Edzer and G{\'o}mez-Rubio, Virgilio}, + title={Applied Spatial Data Analysis with R}, + year={2013}, + publisher={Springer}, + edition = 2, +} + +@Manual{rgeos, + title = {rgeos: Interface to Geometry Engine - Open Source (GEOS)}, + author = {Bivand, Roger S. and Rundel, C.}, + year = {2016}, + note = {R package version 0.3-19}, + url = {https://CRAN.R-project.org/package=rgeos}, + } + +@Manual{gdal, + title = {GDAL - Geospatial Data Abstraction Library, Version 1.11.3}, + author = {{GDAL Development Team}}, + organization = {Open Source Geospatial Foundation}, + year = {2015}, + url = {http://www.gdal.org}, +} + +@Manual{geos, + title = {GEOS - Geometry Engine, Open Source}, + author = {GEOS Development Team}, + organization = {Open Source Geospatial Foundation}, + year = {2016}, + url = {https://trac.osgeo.org/geos/}, +} \ No newline at end of file diff --git a/paper.md b/paper.md new file mode 100644 index 0000000..a261aee --- /dev/null +++ b/paper.md @@ -0,0 +1,29 @@ +--- +title: 'lawn: An R client for Turfjs for Geospatial Analysis' +tags: + - geospatial + - GeoJSON + - javascript +authors: + - name: Scott Chamberlain + orcid: 0000-0003-1444-9135 + affiliation: + - 1 + - name: Jeffrey W. Hollister + orcid: 0000-0002-9254-9740 + affiliation: + - 2 +affiliations: + - name: rOpenSci + index: 1 + - name: US Environmental Protection Agency, Atlantic Ecology Division + index: 2 +date: 16 December 2016 +bibliography: paper.bib +--- + +# Summary + +`lawn` is an R package to provide access to the geospatial analysis capabilities in the `Turf` javascript library [@r; @turfjs]. `Turf` expects data in GeoJSON format. Given that many datasets are now available natively in GeoJSON providing an easier method for conducting geospatial analyses on these datasets in R is desired. Additionally, many existing packages (e.g. `sp` and `rgeos`) do provide similar analysis capabilites; however, they require data be coverted to `sp` objects and also have external dependencies (e.g. `gdal` and `geos`) that can be challenging to maintain on some systems [@bivand2013asdar; @rgeos; @gdal; @geos]. To address these challenges and facilitate geospatial anlysis of GeoJSON formatted data, we developed the `lawn` package. + +# References \ No newline at end of file