R/dependencies.R

In d3r: 'd3.js' Utilities for R

#' 'd3.js' Dependency for Version 7
#'
#' @param offline \code{logical} to specify whether to use
#'         a local copy of d3.js (\code{TRUE}) or use cdn (\code{FALSE})
#' @return \code{htmltools::htmlDependency}
#' @export
#' @examples
#' library(d3r)
#' library(htmltools)
#'
#' tagList(d3_dep_v7())
#' @family 'd3' dependency functions
#' @seealso \code{\link{d3_dep_v6}}, \code{\link{d3_dep_v5}}, \code{\link{d3_dep_v4}}, \code{\link{d3_dep_v3}},
#'   and \code{\link{d3_dep_jetpack}}.
d3_dep_v7 <- function(offline=TRUE){
  if(offline) {
    src = c(file=system.file("www/d3/v7/dist", package="d3r"))
  } else {
    src <- c(href="https://unpkg.com/d3@7.8.5/dist")
  }

  htmltools::htmlDependency(
    name = "d3",
    version = "7.8.5",
    src = src,
    script = "d3.min.js"
  )
}

#' 'd3.js' Dependency for Version 6
#'
#' @param offline \code{logical} to specify whether to use
#'         a local copy of d3.js (\code{TRUE}) or use cdn (\code{FALSE})
#' @return \code{htmltools::htmlDependency}
#' @export
#' @examples
#' library(d3r)
#' library(htmltools)
#'
#' tagList(d3_dep_v6())
#' @family 'd3' dependency functions
#' @seealso \code{\link{d3_dep_v7}}, \code{\link{d3_dep_v5}}, \code{\link{d3_dep_v4}}, \code{\link{d3_dep_v3}},
#'   and \code{\link{d3_dep_jetpack}}.
d3_dep_v6 <- function(offline=TRUE){
  if(offline) {
    src = c(file=system.file("www/d3/v6/dist", package="d3r"))
  } else {
    src <- c(href="https://unpkg.com/d3@6.7.0/dist")
  }

  htmltools::htmlDependency(
    name = "d3",
    version = "6.7.0",
    src = src,
    script = "d3.min.js"
  )
}

#' 'd3.js' Dependency for Version 5
#'
#' @param offline \code{logical} to specify whether to use
#'         a local copy of d3.js (\code{TRUE}) or use cdn (\code{FALSE})
#' @return \code{htmltools::htmlDependency}
#' @export
#' @examples
#' library(d3r)
#' library(htmltools)
#'
#' tagList(d3_dep_v5())
#' @family 'd3' dependency functions
#' @seealso \code{\link{d3_dep_v7}}, \code{\link{d3_dep_v6}}, \code{\link{d3_dep_v4}}, \code{\link{d3_dep_v3}},
#'   and \code{\link{d3_dep_jetpack}}.
d3_dep_v5 <- function(offline=TRUE){
  if(offline) {
    src = c(file=system.file("www/d3/v5/dist", package="d3r"))
  } else {
    src <- c(href="https://unpkg.com/d3@5.16.0/dist")
  }

  htmltools::htmlDependency(
    name = "d3",
    version = "5.16.0",
    src = src,
    script = "d3.min.js"
  )
}

#' 'd3.js' Dependency for Version 4
#'
#' @param offline \code{logical} to specify whether to use
#'         a local copy of d3.js (\code{TRUE}) or use cdn (\code{FALSE})
#' @return \code{htmltools::htmlDependency}
#' @export
#' @examples
#' library(d3r)
#' library(htmltools)
#'
#' tagList(d3_dep_v4())
#' @family 'd3' dependency functions
#' @seealso \code{\link{d3_dep_v7}}, \code{\link{d3_dep_v6}}, \code{\link{d3_dep_v5}}, \code{\link{d3_dep_v3}},
#'   and \code{\link{d3_dep_jetpack}}.
d3_dep_v4 <- function(offline=TRUE){
  if(offline) {
    src = c(file=system.file("www/d3/v4/dist", package="d3r"))
  } else {
    src <- c(href="https://unpkg.com/d3@4.13.0/build")
  }

  htmltools::htmlDependency(
    name = "d3",
    version = "4.13.0",
    src = src,
    script = "d3.min.js"
  )
}

#' 'd3.js' Dependency for Version 3
#'
#' @param offline \code{logical} to specify whether to use
#'         a local copy of d3.js (\code{TRUE}) or use cdn (\code{FALSE})
#' @return \code{htmltools::htmlDependency}
#' @export
#' @examples
#' library(d3r)
#' library(htmltools)
#'
#' tagList(d3_dep_v3())
#' @family 'd3' dependency functions
#' @seealso \code{\link{d3_dep_v7}}, \code{\link{d3_dep_v6}}, \code{\link{d3_dep_v5}}, \code{\link{d3_dep_v4}},
#'   and \code{\link{d3_dep_jetpack}}.
d3_dep_v3 <- function(offline=TRUE){
  if(offline) {
    src = c(file=system.file("www/d3/v3/dist", package="d3r"))
  } else {
    src <- c(href="https://unpkg.com/d3@3.5.17")
  }
  htmltools::htmlDependency(
    name = "d3",
    version = "3.5.17",
    src = src,
    script = "d3.min.js"
  )
}

#' 'd3.js' Dependency for Version 4 Jetpack
#'
#' d3-jetpack is a set of nifty convenience wrappers that speed up
#' your daily work with d3.js. Must be included after \code{d3_dep_v4()}.
#' Learn more by reading \href{https://github.com/gka/d3-jetpack}{d3-jetpack}
#' or by watching this \href{https://www.youtube.com/watch?v=_5ky0AYq_Dg&t=4s}{YouTube}.
#'
#' @param offline \code{logical} to specify whether to use
#'         a local copy of d3.js (\code{TRUE}) or use cdn (\code{FALSE})
#' @return \code{htmltools::htmlDependency}
#' @export
#' @example ./inst/examples/example_d3_jetpack.R
#' @family 'd3' dependency functions
d3_dep_jetpack <- function(offline=TRUE){

  if(offline) {
    src <- c(file=system.file("www/d3/d3-jetpack/dist", package="d3r"))
  } else {
    src <- c(href="https://unpkg.com/d3-jetpack@2.0.9/build")
  }

htmltools::htmlDependency(
    name = "d3-jetpack",
    version = "2.0.9",
    src = src,
    script = "d3-jetpack.js"
  )
}