Skip to content

Commit

Permalink
changes for CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
timelyportfolio committed Nov 16, 2019
1 parent f181b1a commit 6e77062
Show file tree
Hide file tree
Showing 12 changed files with 67 additions and 12 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
@@ -1,3 +1,4 @@
^CRAN-RELEASE$
^cran-comments\.md$
^CODE_OF_CONDUCT\.md$
^LICENSE\.md$
Expand Down
2 changes: 2 additions & 0 deletions CRAN-RELEASE
@@ -0,0 +1,2 @@
This package was submitted to CRAN on 2019-11-09.
Once it is accepted, delete this file and tag the release (commit d105ceb2b4).
6 changes: 4 additions & 2 deletions DESCRIPTION
Expand Up @@ -5,7 +5,7 @@ Date: 2019-11-09
Authors@R: c(
person(
"Jonathan","Skeate"
, role = c("aut", "cph")
, role = c("aut")
, comment = "leaflet-timeline library, https://github.com/skeate/Leaflet.timeline"
),
person(
Expand All @@ -18,7 +18,9 @@ Authors@R: c(
Maintainer: Kent Russell <kent.russell@timelyportfolio.com>
URL: https://github.com/timelyportfolio/leaftime
BugReports: https://github.com/timelyportfolio/leaftime/issues
Description: Use 'leaflet-timeline' plugin with leaflet 'htmlwidget'.
Description: Use the 'leaflet-timeline' plugin with a leaflet 'htmlwidget' to add an
interactive timeline slider with play, pause, and step buttons to explore temporal
geospatial data changes.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,2 +1,2 @@
YEAR: 2019
COPYRIGHT HOLDER: Kenton Russell
COPYRIGHT HOLDER: Kent Russell
2 changes: 1 addition & 1 deletion LICENSE.md
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2019 Kenton Russell
Copyright (c) 2019 Kent Russell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions R/options.R
Expand Up @@ -40,7 +40,7 @@ function(date) {
#' @param drawOnSetTime \code{logical} to draw when time is set. Default is \code{TRUE}. See
#' \href{https://github.com/skeate/Leaflet.timeline#drawonsettime-boolean----optional-default-true}{drawOnSetTime}.
#'
#' @return \code{list}
#' @return \code{list} with options to customize the timeline
#' @seealso \code{\link{addTimeline}}
#' @export

Expand All @@ -67,7 +67,7 @@ timelineOptions <- function(
#' @param fill \code{logical} to determine if drawn will be filled with \code{color}.
#' @param fillOpacity \code{number} between 0 and 1 to set opacity of the drawn circle.
#'
#' @return \code{list}
#' @return \code{list} with options to style the timeline
#' @seealso \code{\link{addTimeline}}
#' @export
styleOptions <- function(
Expand Down Expand Up @@ -104,7 +104,7 @@ styleOptions <- function(
#' @param waitToUpdateMap \code{logical} to wait until user is finished before redrawing.
#' @param showTicks \code{logical} to show ticks on the slider.
#'
#' @return \code{list}
#' @return \code{list} of options to customize the timeline slider
#' @seealso \code{\link{addTimeline}}
#' @export
sliderOptions <- function(
Expand Down
2 changes: 1 addition & 1 deletion R/timeline.R
Expand Up @@ -11,7 +11,7 @@
#' then \code{95\%} or less is recommended to show within the bounds of the map.
#' @param onchange \code{htmlwidgets::JS} function callback for when the timeline is changed.
#'
#' @return \code{leaflet htmlwidget}
#' @return \code{leaflet htmlwidget} with an interactive slider timeline control
#' @importFrom leaflet getMapData
#' @export
#'
Expand Down
50 changes: 50 additions & 0 deletions cran-comments.md
@@ -1,3 +1,53 @@
## Notes

Resubmission

> The Description field is intended to be a (one paragraph) description
of what the package does and why it may be useful. Please elaborate.


Added more detail in the description field


> If there are references describing the methods in your package, please
add these in the description field of your DESCRIPTION file in the form
authors (year) <doi:...>
authors (year) <arXiv:...>
authors (year, ISBN:...)
or if those are not available: <https:...>
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
auto-linking.


These are not available


> Are Kent Russell and Kenton Russell the same person? If yes, please be
consistent in the spelling of the name. If not, please credit Kenton
Russell as the copyright holder in your Authors@R field in your
Description file.


Yes, same person so I changed all to Kent Russell


> Jonathan Skeate is credited as copyright holder, which
is not necessary since he is one of the authors and also does not fit
with what you have stated in the LICENSE file. Please correct/explain.


Jonathan Skeate is the author of the javascript. Based on htmlwidget
best practices with RStudio, I have added CPH for the javascript authors
to all CRAN htmlwidgets I have developeed. To ease the submission, I have
removed the CPH, but I would appreciate guidance going forward on how
best to handle.


> Please elaborate on your \value documentations in your .Rd files.

I added more detail to the \value or return section for each of the functions.

## Test environments
* local Windows install, R 3.4.3
* rhub::check_for_cran
Expand Down
2 changes: 1 addition & 1 deletion man/addTimeline.Rd

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

2 changes: 1 addition & 1 deletion man/sliderOptions.Rd

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

2 changes: 1 addition & 1 deletion man/styleOptions.Rd

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

2 changes: 1 addition & 1 deletion man/timelineOptions.Rd

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

0 comments on commit 6e77062

Please sign in to comment.