From 6e77062ae9baa2b7a802067c3a091fe07ebbf41b Mon Sep 17 00:00:00 2001 From: timelyportfolio Date: Fri, 15 Nov 2019 18:04:16 -0600 Subject: [PATCH] changes for CRAN --- .Rbuildignore | 1 + CRAN-RELEASE | 2 ++ DESCRIPTION | 6 +++-- LICENSE | 2 +- LICENSE.md | 2 +- R/options.R | 6 ++--- R/timeline.R | 2 +- cran-comments.md | 50 ++++++++++++++++++++++++++++++++++++++++++ man/addTimeline.Rd | 2 +- man/sliderOptions.Rd | 2 +- man/styleOptions.Rd | 2 +- man/timelineOptions.Rd | 2 +- 12 files changed, 67 insertions(+), 12 deletions(-) create mode 100644 CRAN-RELEASE diff --git a/.Rbuildignore b/.Rbuildignore index a6e867e..3e425fb 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,4 @@ +^CRAN-RELEASE$ ^cran-comments\.md$ ^CODE_OF_CONDUCT\.md$ ^LICENSE\.md$ diff --git a/CRAN-RELEASE b/CRAN-RELEASE new file mode 100644 index 0000000..50636fc --- /dev/null +++ b/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). diff --git a/DESCRIPTION b/DESCRIPTION index 1cb65e5..fd679ad 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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( @@ -18,7 +18,9 @@ Authors@R: c( Maintainer: Kent Russell 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 diff --git a/LICENSE b/LICENSE index fb9a723..7fa2738 100644 --- a/LICENSE +++ b/LICENSE @@ -1,2 +1,2 @@ YEAR: 2019 -COPYRIGHT HOLDER: Kenton Russell +COPYRIGHT HOLDER: Kent Russell diff --git a/LICENSE.md b/LICENSE.md index 0eb4e3a..863a475 100644 --- a/LICENSE.md +++ b/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 diff --git a/R/options.R b/R/options.R index 5324a4f..62d9961 100644 --- a/R/options.R +++ b/R/options.R @@ -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 @@ -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( @@ -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( diff --git a/R/timeline.R b/R/timeline.R index 745c73b..53c9b30 100644 --- a/R/timeline.R +++ b/R/timeline.R @@ -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 #' diff --git a/cran-comments.md b/cran-comments.md index af2a956..2c31095 100644 --- a/cran-comments.md +++ b/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) +authors (year) +authors (year, ISBN:...) +or if those are not available: +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 diff --git a/man/addTimeline.Rd b/man/addTimeline.Rd index bfcbe52..e847c9c 100644 --- a/man/addTimeline.Rd +++ b/man/addTimeline.Rd @@ -27,7 +27,7 @@ then \code{95\%} or less is recommended to show within the bounds of the map.} \item{onchange}{\code{htmlwidgets::JS} function callback for when the timeline is changed.} } \value{ -\code{leaflet htmlwidget} +\code{leaflet htmlwidget} with an interactive slider timeline control } \description{ Add 'leaflet-timeline' To Leaflet Map diff --git a/man/sliderOptions.Rd b/man/sliderOptions.Rd index 0a23771..95934bd 100644 --- a/man/sliderOptions.Rd +++ b/man/sliderOptions.Rd @@ -34,7 +34,7 @@ the keyboard.} \item{showTicks}{\code{logical} to show ticks on the slider.} } \value{ -\code{list} +\code{list} of options to customize the timeline slider } \description{ Timeline Slider Options Helper diff --git a/man/styleOptions.Rd b/man/styleOptions.Rd index 056a696..79865e9 100644 --- a/man/styleOptions.Rd +++ b/man/styleOptions.Rd @@ -19,7 +19,7 @@ override \code{color}.} \item{fillOpacity}{\code{number} between 0 and 1 to set opacity of the drawn circle.} } \value{ -\code{list} +\code{list} with options to style the timeline } \description{ Timeline Style Options Helper diff --git a/man/timelineOptions.Rd b/man/timelineOptions.Rd index f74dffd..3fa7a17 100644 --- a/man/timelineOptions.Rd +++ b/man/timelineOptions.Rd @@ -23,7 +23,7 @@ on the map. By default, a circle marker will be drawn. See \href{https://github.com/skeate/Leaflet.timeline#drawonsettime-boolean----optional-default-true}{drawOnSetTime}.} } \value{ -\code{list} +\code{list} with options to customize the timeline } \description{ Timeline Options Helper