Skip to content
This repository has been archived by the owner on Sep 30, 2021. It is now read-only.

Commit

Permalink
Making things CRAN ready
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhaskar Karambelkar committed Jun 25, 2017
1 parent 6e1852d commit bcbc331
Show file tree
Hide file tree
Showing 33 changed files with 2,803 additions and 495 deletions.
14 changes: 12 additions & 2 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
^.*\.Rproj$
^\.Rproj\.user$
^NEWS\.md$
^README\.Rmd$
^README\.md$
^README-.*\.png$
^inst/examples
^docs/
^docs$
^cran-comments\.md$
^inst/htmlwidgets/lib/.eslintrc.js$
^inst/examples/.*\.Rmd
^inst/examples/.*\.html
^inst/examples/rsconnect
^\.travis\.yml$
^appveyor\.yml$
^\_pkgdown\.yaml$
^CONDUCT\.md$
25 changes: 25 additions & 0 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
14 changes: 7 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Package: leaflet.esri
Type: Package
Title: ESRI bindings for the Leaflet Package
Version: 0.1.3
Title: 'ESRI' Bindings for the 'leaflet' Package
Version: 0.2
Authors@R: person("Bhaskar", "Karambelkar", email = "[email protected]",
role = c("aut", "cre"))
Description: ESRI bindings for the Leaflet Package.
License: MIT + file LICENSE
Description: An add-on package to the 'leaflet' package, which provides bindings for 'ESRI' services. This package allows a user to add 'ESRI' provided services such as 'MapService', 'ImageMapService', 'TiledMapService' etc. to a 'leaflet' map.
License: GPL-3 | file LICENSE
Depends:
R (>= 3.1.0),
leaflet (>= 1.0.2.9008),
leaflet.extras (>= 0.1.9005)
leaflet (>= 1.1.0),
leaflet.extras (>= 0.2)
Encoding: UTF-8
LazyData: true
Imports:
Expand All @@ -29,4 +29,4 @@ Suggests:
memoise
URL: https://github.com/bhaskarvk/leaflet.esri
BugReports: https://github.com/bhaskarvk/leaflet.esri/issues
RoxygenNote: 6.0.0
RoxygenNote: 6.0.1
676 changes: 674 additions & 2 deletions LICENSE

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# leaflet.esri 0.2

## Major changes

- Made the package CRAN ready

# leaflet.esri 0.1.3

## Major changes
Expand Down
8 changes: 7 additions & 1 deletion R/featureLayers.R
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,12 @@ addEsriFeatureLayer <- function(

#' Add Esri Heatmap Feature Layer.
#'
#' @param map The leaflet map
#' @param url url of the \href{http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Feature_Service/02r3000000z2000000/}{FeatureService} or \href{http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Map_Service/02r3000000w2000000/}{MapService}.
#' @param options options for the featurelayer
#' @param layerId A unique ID for the layer.
#' @param group The name of the group this layer should be added to.
#' the same parameter under \code{\link{addTiles}})
#' @param radius Radius for the heatmap
#' @param gradient The gradient
#' @export
Expand All @@ -212,4 +218,4 @@ addEsriHeatmapFeatureLayer <- function(
leaflet::invokeMethod(
map, leaflet::getMapData(map),
'addEsriHeatmapFeatureLayer', url, layerId, group, options)
}
}
7 changes: 6 additions & 1 deletion R/leaflet.esri-package.r
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
#' leaflet.esri.
#' leaflet.esri: 'ESRI' bindings for the 'leaflet' Package.
#'
#' An add-on package to the 'leaflet' package, which provides bindings for 'ESRI' services.
#' This package allows a user to add 'ESRI' provided services such as
#' 'MapService', 'ImageMapService', 'TiledMapService' etc. to a 'leaflet' map.
#'
#' @importFrom magrittr %>%
#' @import leaflet
#' @import leaflet.extras
Expand Down
25 changes: 16 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(fig.retina=2, fig.path = "README_figs/README-")
```

```{r, echo = FALSE}
description <- readLines(system.file("DESCRIPTION", package='leaflet.esri'))
rvers <- stringr::str_match(grep("R \\(", description, value = TRUE), "[0-9]{1,4}\\.[0-9]{1,4}\\.[0-9]{1,4}")[1,1]
version <- gsub(" ", "", gsub("Version:", "", grep("Version:", description, value = TRUE)))
```

[![Project Status: Active – The project is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Last-changedate](https://img.shields.io/badge/last%20change-`r gsub('-', '--', Sys.Date())`-green.svg)](/commits/master) [![License: GPL-3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/licenses/GPL-3.0) [![keybase verified](https://img.shields.io/badge/keybase-verified-brightgreen.svg)](https://gist.github.com/bhaskarvk/46fbf2ba7b5713151d7e) [![Travis-CI Build Status](https://travis-ci.org/bhaskarvk/leaflet.esri.svg?branch=master)](https://travis-ci.org/bhaskarvk/leaflet.esri) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/bhaskarvk/leaflet.esri?branch=master&svg=true)](https://ci.appveyor.com/project/bhaskarvk/leaflet.esri) [![minimal R version](https://img.shields.io/badge/R%3E%3D-`r rvers`-6666ff.svg)](https://cran.r-project.org/) [![packageversion](https://img.shields.io/badge/Package%20version-`r version`-orange.svg?style=flat-square)](commits/master) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/leaflet.esri)](https://cran.r-project.org/package=leaflet.esri) [![](http://cranlogs.r-pkg.org/badges/grand-total/leaflet.esri)](http://cran.rstudio.com/web/packages/leaflet.esri/index.html)

## ESRI Leaflet bindings.

Expand All @@ -15,11 +25,10 @@ The chart below shows more details.

| Leaflet JS ver. | R Leaflet pkg ver. | esri-leaflet JS Plugin ver. | R leaflet.esri pkg ver.|
| --------------- | ------------------ | --------------------------- | -------------------- |
| [0.7.x](https://github.com/Leaflet/Leaflet/releases/tag/v0.7.7) | [1.1](https://github.com/rstudio/leaflet) <sup>1</sup> | [1.0.4](https://github.com/Esri/esri-leaflet/releases/tag/v1.0.4) | 0.1.x |
| [1.x](https://github.com/Leaflet/Leaflet/releases/tag/v1.0.1) | ? <sup>2</sup> | [2.x](https://github.com/Esri/esri-leaflet/releases/tag/v2.0.4) | ? |
| [0.7.x](https://github.com/Leaflet/Leaflet/releases/tag/v0.7.7) | [1.1](https://github.com/rstudio/leaflet) | [1.0.4](https://github.com/Esri/esri-leaflet/releases/tag/v1.0.4) | 0.2.x |
| [1.x](https://github.com/Leaflet/Leaflet/releases/tag/v1.0.1) | ? <sup>1</sup> | [2.x](https://github.com/Esri/esri-leaflet/releases/tag/v2.0.4) | ? |

1 - Release 1.1 of the leaflet package should hit CRAN very soon, but for now `devtools::install_github('rstudio/leaflet')`. <br/>
2 - The R package has not yet been proted to Leaflet JS 1.x
1 - The R package has not yet been proted to Leaflet JS 1.x

### Features Tracking

Expand Down Expand Up @@ -80,8 +89,6 @@ Tasks are wrappers for commonly used API methods on ArcGIS services. They expose
- removefeature
- addfeature

### License

This package is released under [MIT](https://opensource.org/licenses/MIT).
### Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.

### Known Issues
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->
[![Project Status: Active – The project is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Last-changedate](https://img.shields.io/badge/last%20change-2017--06--25-green.svg)](/commits/master) [![License: GPL-3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/licenses/GPL-3.0) [![keybase verified](https://img.shields.io/badge/keybase-verified-brightgreen.svg)](https://gist.github.com/bhaskarvk/46fbf2ba7b5713151d7e) [![Travis-CI Build Status](https://travis-ci.org/bhaskarvk/leaflet.esri.svg?branch=master)](https://travis-ci.org/bhaskarvk/leaflet.esri) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/bhaskarvk/leaflet.esri?branch=master&svg=true)](https://ci.appveyor.com/project/bhaskarvk/leaflet.esri) [![minimal R version](https://img.shields.io/badge/R%3E%3D-3.1.0-6666ff.svg)](https://cran.r-project.org/) [![packageversion](https://img.shields.io/badge/Package%20version-0.2-orange.svg?style=flat-square)](commits/master) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/leaflet.esri)](https://cran.r-project.org/package=leaflet.esri) [![](http://cranlogs.r-pkg.org/badges/grand-total/leaflet.esri)](http://cran.rstudio.com/web/packages/leaflet.esri/index.html)

ESRI Leaflet bindings.
----------------------

Expand Down Expand Up @@ -27,20 +28,20 @@ As of Feb, 2017 the leaflet R package is based on version 0.7.7 of the Leaflet J
<tbody>
<tr class="odd">
<td><a href="https://github.com/Leaflet/Leaflet/releases/tag/v0.7.7">0.7.x</a></td>
<td><a href="https://github.com/rstudio/leaflet">1.1</a> <sup>1</sup></td>
<td><a href="https://github.com/rstudio/leaflet">1.1</a></td>
<td><a href="https://github.com/Esri/esri-leaflet/releases/tag/v1.0.4">1.0.4</a></td>
<td>0.1.x</td>
<td>0.2.x</td>
</tr>
<tr class="even">
<td><a href="https://github.com/Leaflet/Leaflet/releases/tag/v1.0.1">1.x</a></td>
<td>? <sup>2</sup></td>
<td>? <sup>1</sup></td>
<td><a href="https://github.com/Esri/esri-leaflet/releases/tag/v2.0.4">2.x</a></td>
<td>?</td>
</tr>
</tbody>
</table>

1 - Release 1.1 of the leaflet package should hit CRAN very soon, but for now `devtools::install_github('rstudio/leaflet')`. <br/> 2 - The R package has not yet been proted to Leaflet JS 1.x
1 - The R package has not yet been proted to Leaflet JS 1.x

### Features Tracking

Expand Down Expand Up @@ -101,8 +102,6 @@ Tasks are wrappers for commonly used API methods on ArcGIS services. They expose
- removefeature
- addfeature

### License

This package is released under [MIT](https://opensource.org/licenses/MIT).
### Code of Conduct

### Known Issues
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
44 changes: 44 additions & 0 deletions _pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
title: leaflet.extras
authors:
Bhaskar Karambelkar:
href: https://www.karambelkar.info/

template:
package: pkgdown.bvk
params:
bootswatch: yeti

reference:
- title: Package Documentation
desc: ~
contents:
- '`leaflet.esri`'
- '`addEsriDependency`'
- title: Base Maps
desc: ~
contents:
- '`addEsriBasemapLayer`'
- '`esriBasemapLabels`'
- '`esriBasemapLayers`'
- title: Feature Layer
desc: ~
contents:
- '`addEsriFeatureLayer`'
- '`featureLayerOptions`'
- '`addEsriHeatmapFeatureLayer`'
- title: Dynamic Map Layer
desc: ~
contents:
- '`addEsriDynamicMapLayer`'
- '`dynamicMapLayerOptions`'
- title: Image Map Layer
desc: ~
contents:
- '`addEsriImageMapLayer`'
- '`imageMapLayerOptions`'
- title: Tiled Map Layer
desc: ~
contents:
- '`addEsriTiledMapLayer`'
- '`tiledMapLayerOptions`'

23 changes: 23 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Test environments
* local OS X install, R 3.4.0
* ubuntu 12.04 (on travis-ci), R 3.4.0
* win-builder (devel and release)

## R CMD check results

0 errors | 0 warnings | 1 note

* This is a new release.

## Reverse dependencies

This is a new release, so there are no reverse dependencies.

---

* I have run R CMD check on the NUMBER downstream dependencies.
(Summary at ...).

* FAILURE SUMMARY

* All revdep maintainers were notified of the release on RELEASE DATE.
Loading

0 comments on commit bcbc331

Please sign in to comment.