From d65f8b594f341f1858f685c954c18251b62201a3 Mon Sep 17 00:00:00 2001 From: Ian Lyttle Date: Thu, 11 Jul 2019 12:31:33 +0200 Subject: [PATCH] Update version, add installation instructions, as if on CRAN (#115) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update version, add installation instructions, as if on CRAN * Update pkgdown dev mode, add cran comments, README urls, formatting in CONTRIBUTING * Update cran comments * correct spelling * Update for resubmission * Address CRAN concerns: - add to Python and Altair to SystemRequirements - deprecate some functions re-exported from vegawidget - update CRAN comments - update NEWS - update pkgdown reference * Update cran comments * update CRAN comments * Correct date of email * one more edit * Make CRAN corrections 🎉 on CRAN --- .Rbuildignore | 2 ++ CONTRIBUTING.Rmd | 4 ++- CONTRIBUTING.md | 15 ++++++---- DESCRIPTION | 5 ++-- NAMESPACE | 4 --- NEWS.md | 6 ++-- R/alt.R | 7 +++-- R/deprecated.R | 39 ++++++++++++++++++++++++++ R/install.R | 18 ++++++++---- R/utils-vegawidget.R | 43 ----------------------------- README.Rmd | 16 +++++++++-- README.md | 25 +++++++++++------ cran-comments.md | 61 +++++++++++++++++++++++++++++++++++++++++ man/as_chart.Rd | 6 ++-- man/check_altair.Rd | 1 + man/install_altair.Rd | 1 + man/renderVegawidget.Rd | 16 +++++++++-- man/spec_mtcars.Rd | 14 ---------- man/vegawidgetOutput.Rd | 22 +++++++++++++-- man/vw_as_json.Rd | 15 ++++++++-- pkgdown/_pkgdown.yml | 12 +++++--- 21 files changed, 227 insertions(+), 105 deletions(-) create mode 100644 R/deprecated.R create mode 100644 cran-comments.md delete mode 100644 man/spec_mtcars.Rd diff --git a/.Rbuildignore b/.Rbuildignore index 778afaba..b6d24334 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -12,3 +12,5 @@ ^\.gitattributes$ ^CONTRIBUTING\.md$ ^CONTRIBUTING\.Rmd$ +^cran-comments\.md$ +^CRAN-RELEASE$ diff --git a/CONTRIBUTING.Rmd b/CONTRIBUTING.Rmd index 1be8fae2..7136a737 100644 --- a/CONTRIBUTING.Rmd +++ b/CONTRIBUTING.Rmd @@ -88,7 +88,7 @@ Please build pkgdown as much as you would like - the `docs` folder is git-ignore ### Versioning -The version nuumber may have as many as four components. The first two digits will mirror the first two digits of the version number of the supported (Python) Altair version; this is currently ``r altair::altair_version()$altair``. +The version number may have as many as four components. The first two digits will mirror the first two digits of the version number of the supported (Python) Altair version; this is currently ``r altair::altair_version()$altair``. The third component will correspond to a CRAN release of this package; these will be tagged. @@ -108,6 +108,8 @@ adding a vignette | `master` | `r mark_yes` | `r g helping with a new feature | `` | `r mark_no` | `r grin` proposing a new feature | `master` | `r mark_yes` | `r grin` +
+ Please roxygenize as a part of your pull-request. ### Git branch strategy diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f06ac45a..b85b4e44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,14 +114,14 @@ documentation is at the “root” of the documentation site; the latest ### Versioning -The version nuumber may have as many as five components. The first three -digits will mirror the version number of the supported (Python) Altair -version; this is currently `3.1.0`. +The version number may have as many as four components. The first two +digits will mirror the first two digits of the version number of the +supported (Python) Altair version; this is currently `3.1.0`. -The fourth component will correspond to a CRAN release of this package; +The third component will correspond to a CRAN release of this package; these will be tagged. -A fifth component denotes a development version. +A fourth component denotes a development version. Our goal is that each commit to the `master` branch will have an incremented version-number. @@ -129,7 +129,8 @@ incremented version-number. ### Pull requests Pull requests are very welcome. Accordingly, the branch into which you -should make a pull-request will depend on the situation: +should make a pull-request will depend on the +situation: | Situation | Reference branch | Add item to NEWS.md | Appreciated | | -------------------------- | ------------------ | ------------------- | ----------- | @@ -139,6 +140,8 @@ should make a pull-request will depend on the situation: | helping with a new feature | `` | ❎ | 😁 | | proposing a new feature | `master` | ✅ | 😁 | +
+ Please roxygenize as a part of your pull-request. ### Git branch strategy diff --git a/DESCRIPTION b/DESCRIPTION index 012949cb..8870410a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: altair -Version: 3.1.0.9011 -Title: R Interface to 'Altair' +Version: 3.1.1 +Title: Interface to 'Altair' Description: Interface to 'Altair' , which itself is a 'Python' interface to 'Vega-Lite' . This package uses the 'Reticulate' framework @@ -26,6 +26,7 @@ Authors@R: c( person("Jake", "Vanderplas", comment = "Altair library", role = c("ctb")), person("Brian", "Granger", comment = "Altair library", role = c("ctb")) ) +SystemRequirements: Python (>= 3.5.0), (Python) Altair (>= 3.1.0) License: MIT + file LICENSE Encoding: UTF-8 LazyData: true diff --git a/NAMESPACE b/NAMESPACE index 0e032a66..5311fc26 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -21,7 +21,6 @@ export(knit_print.altair.vegalite.v3.api.TopLevelMixin) export(knit_print.vegaspec) export(renderVegawidget) export(repr_vegalite3.altair.vegalite.v3.api.Chart) -export(spec_mtcars) export(vega_embed) export(vegawidget) export(vegawidgetOutput) @@ -35,11 +34,8 @@ importFrom(repr,repr_text) importFrom(repr,repr_vegalite2) importFrom(vegawidget,as_vegaspec) importFrom(vegawidget,knit_print.vegaspec) -importFrom(vegawidget,renderVegawidget) importFrom(vegawidget,vega_embed) importFrom(vegawidget,vegawidget) -importFrom(vegawidget,vegawidgetOutput) -importFrom(vegawidget,vw_as_json) importFrom(vegawidget,vw_to_bitmap) importFrom(vegawidget,vw_to_svg) importFrom(vegawidget,vw_write_png) diff --git a/NEWS.md b/NEWS.md index 3e5fc3e2..e36c8b1c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,6 @@ -# altair 3.1.0 (development version) +# altair 3.1.1 + +* Deprecate `vw_as_json()`, `vegawidgetOutput()`, `renderVegawidget()`; these are available in the **vegawidget** package. (#117) * Remove references to `r_to_py()`, as **retuculate** manages this automatically. (#83) @@ -36,7 +38,7 @@ * adds `as_chart()`, to import a vegaspec as an Altair chart -* revomes rendering functions in favor of a separate package, [**vegawidget**](https://github.com/vegawidget/vegawidget) - vegawidget functions imported and exported using templating function `vegawidget::use_vegawidget()`. +* removes rendering functions in favor of a separate package, [**vegawidget**](https://github.com/vegawidget/vegawidget) - vegawidget functions imported and exported using templating function `vegawidget::use_vegawidget()`. * adds requirement to use reticulate (>=) 1.9, to avoid conflict between data-frame variable-names and python methods (#50, @aliciaschep) and to remove the need to use the `r_to_py()` function for data (#83) diff --git a/R/alt.R b/R/alt.R index f1cd200d..7df5572b 100644 --- a/R/alt.R +++ b/R/alt.R @@ -1,10 +1,11 @@ # see zzz.R for "creation" of the alt object -#' Create Altair chart from vegaspec +#' Create Altair chart from vegaspec #' -#' @param spec vegaspec +#' @inheritParams as_vegaspec #' #' @return altair object +#' #' @examples #' if (interactive()) { #' as_chart(vegawidget::spec_mtcars) @@ -14,7 +15,7 @@ as_chart <- function(spec) { spec <- as_vegaspec(spec) - spec <- vw_as_json(spec) + spec <- vegawidget::vw_as_json(spec) chart <- alt$Chart()$from_json(spec) diff --git a/R/deprecated.R b/R/deprecated.R new file mode 100644 index 00000000..943c01c6 --- /dev/null +++ b/R/deprecated.R @@ -0,0 +1,39 @@ +#' Coerce vegaspec to JSON +#' +#' Deprecated, please use \code{vegawidget::\link[vegawidget]{vw_as_json}}. +#' +#' @inherit vegawidget::vw_as_json params return +#' @export +#' +vw_as_json <- function(spec, pretty = TRUE) { + .Deprecated("vegawidget::vw_as_json") + vegawidget::vw_as_json(spec, pretty = pretty) +} + +#' Shiny-output for vegawidget +#' +#' Deprecated, please use \code{vegawidget::\link[vegawidget]{vegawidgetOutput}}. +#' +#' @inherit vegawidget::vegawidgetOutput params return +#' @export +#' +vegawidgetOutput <- function(outputId, width = "auto", height = "auto") { + .Deprecated("vegawidget::vegawidgetOutput") + vegawidget::vegawidgetOutput( + outputId = outputId, + width = width, + height = height + ) +} + +#' Render shiny-output for vegawidget +#' +#' Deprecated, please use \code{vegawidget::\link[vegawidget]{renderVegawidget}}. +#' +#' @inherit vegawidget::renderVegawidget params return +#' @export +#' +renderVegawidget <- function(expr, env = parent.frame(), quoted = FALSE) { + .Deprecated("vegawidget::renderVegawidget") + vegawidget::renderVegawidget(expr = expr, env = env, quoted = quoted) +} diff --git a/R/install.R b/R/install.R index d20bc03f..83b311f5 100644 --- a/R/install.R +++ b/R/install.R @@ -33,6 +33,7 @@ #' [reticulate: Installing Python Packages](https://rstudio.github.io/reticulate/articles/python_packages.html) #' @examples #' \dontrun{ +#' # not run because it requires Python #' install_altair() #' } #' @export @@ -114,6 +115,7 @@ install_altair <- function(method = c("conda", "virtualenv"), #' @seealso [reticulate::py_config()], [install_altair()], [altair_version()] #' @examples #' \dontrun{ +#' # not run because it requires Python #' check_altair() #' } #' @export @@ -157,13 +159,14 @@ altair_version <- function() { #' @return invisible `NULL`, called for side-effects #' @keywords internal #' @examples -#' \dontrun{ #' version_supported <- "2.0.1" -#' # issues error -#' check_altair_version("1.2", version_supported) +#' \donttest{ +#' # issues error +#' check_altair_version("1.2", version_supported) #' -#' # issues warning -#' check_altair_version("2.1", version_supported) +#' # issues warning +#' check_altair_version("2.1", version_supported) +#' } #' #' # issues message #' check_altair_version("2.0.0", version_supported) @@ -171,13 +174,16 @@ altair_version <- function() { #' #' # does nothing #' check_altair_version("2.0.1", version_supported) -#' } #' check_altair_version <- function(version_installed = altair_version()$altair, version_supported = getOption("altair.python.version"), quiet = FALSE) { + if (is.null(version_supported)) { + stop("`version_supported` is NULL, is `altair` package loaded?") + } + installed <- get_version_components(version_installed) supported <- get_version_components(version_supported) diff --git a/R/utils-vegawidget.R b/R/utils-vegawidget.R index d7db87ab..80a6e985 100644 --- a/R/utils-vegawidget.R +++ b/R/utils-vegawidget.R @@ -11,17 +11,6 @@ #' NULL -#' Coerce vegaspec to JSON -#' -#' See \code{vegawidget::\link[vegawidget]{vw_as_json}} for details. -#' -#' @name vw_as_json -#' @rdname vw_as_json -#' @importFrom vegawidget vw_as_json -#' @export -#' -NULL - #### print functions #### #' Knit-print method @@ -74,37 +63,5 @@ NULL #' NULL -#### shiny functions #### - -#' Shiny-output for vegawidget -#' -#' See \code{vegawidget::\link[vegawidget]{vegawidgetOutput}} for details. -#' -#' @name vegawidgetOutput -#' @rdname vegawidgetOutput -#' @importFrom vegawidget vegawidgetOutput -#' @export -#' -NULL - -#' Render shiny-output for vegawidget -#' -#' See \code{vegawidget::\link[vegawidget]{renderVegawidget}} for details. -#' -#' @name renderVegawidget -#' @rdname renderVegawidget -#' @importFrom vegawidget renderVegawidget -#' @export -#' -NULL -#### specs #### -#' Example vegaspecs -#' -#' See \code{vegawidget::\link[vegawidget]{spec_mtcars}} for details. -#' -#' @name spec_mtcars -#' @export -#' -spec_mtcars <- vegawidget::spec_mtcars diff --git a/README.Rmd b/README.Rmd index 951ff5bf..47083754 100644 --- a/README.Rmd +++ b/README.Rmd @@ -13,6 +13,10 @@ knitr::opts_chunk$set( fig.path = "man/figures/README-", dev = "svg" ) + +url_local <- function(x) { + file.path("https://vegawidget.github.io/altair", x) +} ``` [![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) @@ -27,7 +31,13 @@ In this documentation, the capitalized word **Altair** shall refer to the Python ## Installation -A development version is available from [GitHub](https://github.com/): +You can install altair from CRAN with: + +```{r cran-installation, eval=FALSE} +install.packages("altair") +``` + +The development version of is available from [GitHub](https://github.com/): ``` r # install.packages("devtools") @@ -135,7 +145,7 @@ This project is a collaborative effort. In addition to the principal authors: ## Contributing -Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). +Please note that this project is released with a [Contributor Code of Conduct](`r url_local("CODE_OF_CONDUCT.html")`). By participating in this project you agree to abide by its terms. -This project also has a [Contributing Guide](CONTRIBUTING.md). +This project also has a [Contributing Guide](`r url_local("CONTRIBUTING.html")`). diff --git a/README.md b/README.md index 701f50b3..8152e3bd 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,14 @@ package. ## Installation -A development version is available from [GitHub](https://github.com/): +You can install altair from CRAN with: + +``` r +install.packages("altair") +``` + +The development version of is available from +[GitHub](https://github.com/): ``` r # install.packages("devtools") @@ -79,7 +86,7 @@ to convert Altair charts into SVG strings or write SVG files. With the **[png](https://CRAN.R-project.org/package=png)** packages installed, you can get a bitmap array, or write PNG files. -When knitting to a non-HTML format, e.g. `github_document`, this package +When knitting to a non-HTML format, e.g. `github_document`, this package provides a `knit_print()` function that will intercept the normal renderer, using instead its own renderer, allowing you to specify `"png"` , `"svg"` or `"pdf"`. Like the image functions, this requires @@ -115,9 +122,9 @@ Some things to keep in mind: - Where you see a `.` in the Python examples, use a `$` instead. - In your data, columns that contain dots can be wrapped in square - brackets in Altair specifications, e.g. `[Sepal.Width]`, to keep + brackets in Altair specifications, e.g. `[Sepal.Width]`, to keep Altair from throwing an error. Alternatively, you can use a - double-backslash, e.g. `Sepal\\.Width`. + double-backslash, e.g. `Sepal\\.Width`. These and other “gotchas” are compiled, along with workarounds, in an article: [Field Guide to Python @@ -130,7 +137,8 @@ The documentation for this package includes some - [Getting Started](https://vegawidget.github.io/altair/articles/altair.html): - a walkthrough to get a first chart to work + a walkthrough to get a first chart to + work - [Installation](https://vegawidget.github.io/altair/articles/installation.html): some more-detailed instructions @@ -210,7 +218,8 @@ authors: ## Contributing Please note that this project is released with a [Contributor Code of -Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree -to abide by its terms. +Conduct](https://vegawidget.github.io/altair/CODE_OF_CONDUCT.html). By +participating in this project you agree to abide by its terms. -This project also has a [Contributing Guide](CONTRIBUTING.md). +This project also has a [Contributing +Guide](https://vegawidget.github.io/altair/CONTRIBUTING.html). diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 00000000..aece93d0 --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,61 @@ +# altair 3.1.1 (resubmission) + +## Resubmission + +This is a resubmission. Following Martina Schmirl's email of 2019-07-07: + +* I have amended the title to remove the redundant R. + +* I have noted for each of the two remaining instances of `\dontrun{}` that + these examples make calls to Python (missing additional software). + +* I have amended an example-set to use `donttest{}` as these examples, as run, + do not call Python. + +This is a resubmission. Following Uwe Ligge's email of 2019-06-28: + +* I have added Python and Altair as `SystemRequirements` - my apologies for + missing this. + +* The functions from the other package, 'vegawidget', are exported. + + The 'vegawidget' package offers functions to render 'Vega' and 'Vega-Lite' + specifications in the browser. The 'altair' package lets you + build Vega-Lite specifications by exposing the Python Altair library. + + As such, 'altair' exports the 'vegawidget' rendering-functions. + There may be developed other packages that build Vega and Vega-Lite + specifications, for which 'vegawidget' offers a common set of + rendering functions. + + I have reassessed the functions that are re-exported. I have deprecated three + of these functions, in favor of using 'vegawidget' directly. + +## Test environments + +* local OS X install, R 3.5.3 +* ubuntu 14.04 (on travis-ci), R (oldrel, release, and devel) +* Windows Server 2008 R2 SP1, R-devel, 32/64 bit +* Ubuntu Linux 16.04 LTS, R-release, GCC +* Fedora Linux, R-devel, clang, gfortran +* win-builder (devel and release) + +## R CMD check results + +0 errors | 0 warnings | 1 note + +* This is a new release. + +## Author notes + +* This package offers a pass-through to a Python library, Altair. Its + functionality is to install Altair, then to establish the connection between R + and Python. + + As such, virtually all the examples and tests cannot be run on CRAN servers, + hence the \dontrun{} and the like on examples, and skipping of tests. + + This functionality is tested on Travis, where the Python libraries are available. + +* The initial version (3.1.1) is advanced because we are using the first two + digits to mirror our supported version of Python Altair (3.1). diff --git a/man/as_chart.Rd b/man/as_chart.Rd index 27f52867..e2d82651 100644 --- a/man/as_chart.Rd +++ b/man/as_chart.Rd @@ -2,18 +2,18 @@ % Please edit documentation in R/alt.R \name{as_chart} \alias{as_chart} -\title{Create Altair chart from vegaspec} +\title{Create Altair chart from vegaspec} \usage{ as_chart(spec) } \arguments{ -\item{spec}{vegaspec} +\item{spec}{An object to be coerced to \code{vegaspec}, a Vega/Vega-Lite specification} } \value{ altair object } \description{ -Create Altair chart from vegaspec +Create Altair chart from vegaspec } \examples{ if (interactive()) { diff --git a/man/check_altair.Rd b/man/check_altair.Rd index abb82efe..8772adad 100644 --- a/man/check_altair.Rd +++ b/man/check_altair.Rd @@ -37,6 +37,7 @@ called \code{"r-reticulate"}, use \code{\link[=install_altair]{install_altair()} } \examples{ \dontrun{ + # not run because it requires Python check_altair() } } diff --git a/man/install_altair.Rd b/man/install_altair.Rd index 8995cf6a..96100843 100644 --- a/man/install_altair.Rd +++ b/man/install_altair.Rd @@ -45,6 +45,7 @@ or in this package's \href{https://vegawidget.github.io/altair/articles/installa } \examples{ \dontrun{ + # not run because it requires Python install_altair() } } diff --git a/man/renderVegawidget.Rd b/man/renderVegawidget.Rd index 01ba86fd..d61d850d 100644 --- a/man/renderVegawidget.Rd +++ b/man/renderVegawidget.Rd @@ -1,8 +1,20 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils-vegawidget.R +% Please edit documentation in R/deprecated.R \name{renderVegawidget} \alias{renderVegawidget} \title{Render shiny-output for vegawidget} +\usage{ +renderVegawidget(expr, env = parent.frame(), quoted = FALSE) +} +\arguments{ +\item{expr}{expression that generates a vegawidget. This can be +a \code{vegawidget} or a \code{vegaspec}.} + +\item{env}{The environment in which to evaluate \code{expr}.} + +\item{quoted}{Is \code{expr} a quoted expression (with \code{quote()})? This +is useful if you want to save an expression in a variable.} +} \description{ -See \code{vegawidget::\link[vegawidget]{renderVegawidget}} for details. +Deprecated, please use \code{vegawidget::\link[vegawidget]{renderVegawidget}}. } diff --git a/man/spec_mtcars.Rd b/man/spec_mtcars.Rd deleted file mode 100644 index a492e927..00000000 --- a/man/spec_mtcars.Rd +++ /dev/null @@ -1,14 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils-vegawidget.R -\docType{data} -\name{spec_mtcars} -\alias{spec_mtcars} -\title{Example vegaspecs} -\format{An object of class \code{vegaspec_unit} (inherits from \code{vegaspec_vega_lite}, \code{vegaspec}, \code{list}) of length 7.} -\usage{ -spec_mtcars -} -\description{ -See \code{vegawidget::\link[vegawidget]{spec_mtcars}} for details. -} -\keyword{datasets} diff --git a/man/vegawidgetOutput.Rd b/man/vegawidgetOutput.Rd index 4a68162c..fa83d132 100644 --- a/man/vegawidgetOutput.Rd +++ b/man/vegawidgetOutput.Rd @@ -1,8 +1,26 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils-vegawidget.R +% Please edit documentation in R/deprecated.R \name{vegawidgetOutput} \alias{vegawidgetOutput} \title{Shiny-output for vegawidget} +\usage{ +vegawidgetOutput(outputId, width = "auto", height = "auto") +} +\arguments{ +\item{outputId}{output variable to read from} + +\item{width}{Must be a valid CSS unit (like \code{"100\%"}, +\code{"400px"}, \code{"auto"}) or a number, which will be coerced to a +string and have \code{"px"} appended. For vegawidgets, \code{"auto"} is useful +because, as of now, the spec determines the size of the widget, then the +widget determines the size of the container.} + +\item{height}{Must be a valid CSS unit (like \code{"100\%"}, +\code{"400px"}, \code{"auto"}) or a number, which will be coerced to a +string and have \code{"px"} appended. For vegawidgets, \code{"auto"} is useful +because, as of now, the spec determines the size of the widget, then the +widget determines the size of the container.} +} \description{ -See \code{vegawidget::\link[vegawidget]{vegawidgetOutput}} for details. +Deprecated, please use \code{vegawidget::\link[vegawidget]{vegawidgetOutput}}. } diff --git a/man/vw_as_json.Rd b/man/vw_as_json.Rd index d74d2533..33a97e24 100644 --- a/man/vw_as_json.Rd +++ b/man/vw_as_json.Rd @@ -1,8 +1,19 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils-vegawidget.R +% Please edit documentation in R/deprecated.R \name{vw_as_json} \alias{vw_as_json} \title{Coerce vegaspec to JSON} +\usage{ +vw_as_json(spec, pretty = TRUE) +} +\arguments{ +\item{spec}{An object to be coerced to \code{vegaspec}, a Vega/Vega-Lite specification} + +\item{pretty}{\code{logical} indicates to use pretty (vs. minified) formatting} +} +\value{ +\code{jsonlite::json} object +} \description{ -See \code{vegawidget::\link[vegawidget]{vw_as_json}} for details. +Deprecated, please use \code{vegawidget::\link[vegawidget]{vw_as_json}}. } diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index bf0079e1..cbcab169 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -6,7 +6,7 @@ template: index_name: altair development: - mode: unreleased + mode: auto reference: - title: Installation @@ -24,7 +24,6 @@ reference: - import_vega_data - as_chart - as_vegaspec - - vw_as_json - altair_concatenation - title: Rendering desc: > @@ -32,14 +31,19 @@ reference: contents: - vegawidget - vega_embed - - renderVegawidget - - vegawidgetOutput - knit_print.altair.vegalite.v3.api.TopLevelMixin - image - title: Package desc: Overview of the package contents: - altair + - title: Deprecated + desc: > + These functions are available in [vegawidget](https://vegawidget.github.io/vegawidget/reference/index.html) + contents: + - vw_as_json + - vegawidgetOutput + - renderVegawidget articles: - title: Installation