Skip to content

Commit

Permalink
prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
ijlyttle committed Mar 13, 2023
1 parent bf808e6 commit 9715044
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 77 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
^CRAN-RELEASE$
^\.github$
^revdep$
^venv$
105 changes: 51 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ chart

Some things to keep in mind:

- Where you see a `.` in the Python examples, use a `$` instead.
- 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
Altair from throwing an error. Alternatively, you can use a
double-backslash, e.g. `Sepal\\.Width`.
- In your data, columns that contain dots can be wrapped in square
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`.

These and other “gotchas” are compiled along with workarounds in an
article: [Field Guide to Python
Expand Down Expand Up @@ -136,72 +136,69 @@ installed.
The documentation for this package includes some
[articles](https://vegawidget.github.io/altair/articles/index.html):

- [Getting
Started](https://vegawidget.github.io/altair/articles/altair.html):
a walkthrough to get a first chart to work
- [Getting
Started](https://vegawidget.github.io/altair/articles/altair.html): a
walkthrough to get a first chart to work

- [Installation](https://vegawidget.github.io/altair/articles/installation.html):
some more-detailed instructions
- [Installation](https://vegawidget.github.io/altair/articles/installation.html):
some more-detailed instructions

Gallery:

- An adaptation to R of the [Altair Example
Gallery](https://altair-viz.github.io/gallery/), to demonstrate (not
least to ourselves) that we are not missing any of the
expressiveness of the Python API. You may be interested in the
[Interactive
Charts](https://vegawidget.github.io/altair/articles/example-gallery-08-interactive-charts.html)
examples.
- An adaptation to R of the [Altair Example
Gallery](https://altair-viz.github.io/gallery/), to demonstrate (not
least to ourselves) that we are not missing any of the expressiveness
of the Python API. You may be interested in the [Interactive
Charts](https://vegawidget.github.io/altair/articles/example-gallery-08-interactive-charts.html)
examples.

Examples:

- [Tooltips](https://vegawidget.github.io/altair/articles/tooltips.html):
shows how Vega-Lite implements tooltips as an encoding within a
chart, with formatting options
- [Tooltips](https://vegawidget.github.io/altair/articles/tooltips.html):
shows how Vega-Lite implements tooltips as an encoding within a chart,
with formatting options

- [Vega
Datasets](https://vegawidget.github.io/altair/articles/vega-datasets.html):
work with [Vega
datasets](https://github.com/altair-viz/vega_datasets) using
`import_vega_data()`
- [Vega
Datasets](https://vegawidget.github.io/altair/articles/vega-datasets.html):
work with [Vega datasets](https://github.com/altair-viz/vega_datasets)
using `import_vega_data()`

- [View
Composition](https://vegawidget.github.io/altair/articles/view-composition.html):
how to facet, add layers to, repeat, and concatenate charts
- [View
Composition](https://vegawidget.github.io/altair/articles/view-composition.html):
how to facet, add layers to, repeat, and concatenate charts

- [Interactive
Examples](https://vegawidget.github.io/altair/articles/interactive.html):
a set of examples that work towards linked-brushing of two
scatterplots
- [Interactive
Examples](https://vegawidget.github.io/altair/articles/interactive.html):
a set of examples that work towards linked-brushing of two
scatterplots

Field Guides:

- [Field Guide to Python
Issues](https://vegawidget.github.io/altair/articles/field-guide-python.html):
“gotchas” and their workarounds
- [Field Guide to Python
Issues](https://vegawidget.github.io/altair/articles/field-guide-python.html):
“gotchas” and their workarounds

- [Field Guide to Rendering
Charts](https://vegawidget.github.io/altair/articles/field-guide-rendering.html):
specify options to render charts as HTML
- [Field Guide to Rendering
Charts](https://vegawidget.github.io/altair/articles/field-guide-rendering.html):
specify options to render charts as HTML

## Acknowledgements

This package rests on these foundations:

- [Altair](https://altair-viz.github.io): Python interface to
Vega-Lite
- [Altair](https://altair-viz.github.io): Python interface to Vega-Lite

- [reticulate](https://rstudio.github.io/reticulate/): R framework to
work with Python
- [reticulate](https://rstudio.github.io/reticulate/): R framework to
work with Python

- [Vega-Lite](https://vega.github.io/vega-lite/): a grammar of
interactive graphics
- [Vega-Lite](https://vega.github.io/vega-lite/): a grammar of
interactive graphics

- [vegawidget](https://vegawidget.github.io/vegawidget/): R package to
render Vega(-Lite) visualizations
- [vegawidget](https://vegawidget.github.io/vegawidget/): R package to
render Vega(-Lite) visualizations

- [htmlwidgets](https://www.htmlwidgets.org/): R framework to work
with JavaScript visualizations
- [htmlwidgets](https://www.htmlwidgets.org/): R framework to work with
JavaScript visualizations

As well, a particular debt is owed to the folks behind the
[vegalite](https://github.com/hrbrmstr/vegalite) package, as it provided
Expand All @@ -210,13 +207,13 @@ a lot of the inspiration for these efforts.
This project is a collaborative effort. In addition to the principal
authors:

- [Alicia Schep](https://github.com/AliciaSchep) has contributed the
concatenation functions, as well as sorted out many of the Python,
JavaScript, and package-API issues.
- [Alicia Schep](https://github.com/AliciaSchep) has contributed the
concatenation functions, as well as sorted out many of the Python,
JavaScript, and package-API issues.

- [Heike Hofmann](https://github.com/heike) has been an invaluable
advisor, providing incisive feedback, and insight into the
fundamentals of interactive graphics.
- [Heike Hofmann](https://github.com/heike) has been an invaluable
advisor, providing incisive feedback, and insight into the
fundamentals of interactive graphics.

## Contributing

Expand Down
4 changes: 3 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## R CMD check results

0 errors | 0 warnings | 0 notes
0 errors | 0 warnings | 1 notes

- Changing maintainer's email address.

## revdepcheck results

Expand Down
2 changes: 1 addition & 1 deletion man/alt.Rd

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

58 changes: 37 additions & 21 deletions revdep/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,45 @@
# Platform

|field |value |
|:--------|:----------------------------|
|version |R version 4.1.2 (2021-11-01) |
|os |macOS Monterey 12.1 |
|system |x86_64, darwin17.0 |
|ui |RStudio |
|language |(EN) |
|collate |en_US.UTF-8 |
|ctype |en_US.UTF-8 |
|tz |America/Chicago |
|date |2022-02-14 |
|field |value |
|:--------|:-------------------------------------------------------------------------------------------|
|version |R version 4.2.2 (2022-10-31) |
|os |macOS Ventura 13.2.1 |
|system |aarch64, darwin20 |
|ui |RStudio |
|language |(EN) |
|collate |en_US.UTF-8 |
|ctype |en_US.UTF-8 |
|tz |America/Chicago |
|date |2023-03-12 |
|rstudio |2022.12.0+353 Elsbeth Geranium (desktop) |
|pandoc |2.19.2 @ /Applications/RStudio.app/Contents/Resources/app/quarto/bin/tools/ (via rmarkdown) |

# Dependencies

|package |old |new |Δ |
|:--------|:-----|:----------|:--|
|altair |4.1.1 |4.2.0.9004 |* |
|cli |NA |3.2.0 |* |
|crayon |NA |1.5.0 |* |
|magrittr |NA |2.0.2 |* |
|pillar |NA |1.7.0 |* |
|repr |NA |1.1.4 |* |
|rlang |NA |1.0.1 |* |
|yaml |NA |2.2.2 |* |
|package |old |new |Δ |
|:-----------|:-----|:----------|:--|
|altair |4.2.1 |4.2.1.9002 |* |
|cachem |NA |1.0.7 |* |
|cli |NA |3.6.0 |* |
|evaluate |NA |0.20 |* |
|fansi |NA |1.0.4 |* |
|fastmap |NA |1.1.1 |* |
|fs |NA |1.6.1 |* |
|htmlwidgets |NA |1.6.1 |* |
|knitr |NA |1.42 |* |
|png |NA |0.1-8 |* |
|Rcpp |NA |1.0.10 |* |
|RcppTOML |NA |0.2.2 |* |
|repr |1.1.6 |1.1.6 | |
|reticulate |NA |1.25-9010 |* |
|rmarkdown |NA |2.20 |* |
|sass |NA |0.4.5 |* |
|stringi |NA |1.7.12 |* |
|tinytex |NA |0.44 |* |
|utf8 |NA |1.2.3 |* |
|vctrs |NA |0.5.2 |* |
|xfun |NA |0.37 |* |
|yaml |NA |2.3.7 |* |

# Revdeps

0 comments on commit 9715044

Please sign in to comment.