Merge pull request #105 from animint/reference-website-yay

Making the Reference Website Official

Author: tdhock

.Rbuildignore

@@ -6,11 +6,15 @@ data-raw
 IDEAS.html
 IDEAS.org
 inst/examples
-README.org
+README.md
 tableau-notes.org
 .*~
 intreg-selection
 animint-htmltest
 ANIMINT_TEST_FOO
 test-compiler-gist.R
-.httr-oauth
+.httr-oauth
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.gitignore

@@ -9,4 +9,4 @@
 *WorldBank-all*
 *ANIMINT_TEST_FOO
 *pids.txt
-*~
+*~

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: animint2
 Title: Animated Interactive Grammar of Graphics
 Version: 2023.6.11
-URL: https://github.com/tdhock/animint2
-BugReports: https://github.com/tdhock/animint2/issues
+URL: https://animint.github.io/animint2/
+BugReports: https://github.com/animint/animint2/issues
 Authors@R: c(
     person("Toby", "Hocking",
      email="[email protected]",
@@ -49,7 +49,10 @@ Authors@R: c(
      comment="Animint2 GSoC 2020"),
     person("Yufan", "Fei",
      role="aut",
-     comment="Animint2 GSoC 2022"))
+     comment="Animint2 GSoC 2022"),
+	person("Jocelyne", "Chen",
+	 role="aut",
+	 comment="Animint2 GSoC 2023"))
 Description: Functions are provided for defining animated,
  interactive data visualizations in R code, and rendering
  on a web page. The 2018 Journal of Computational and 
@@ -274,3 +277,4 @@ Collate:
     'z_theme_animint.R'
     'z_transformShape.R'
 RoxygenNote: 7.2.3
+Config/Needs/website: tidyverse/tidytemplate

NEWS renamed to NEWS.md

@@ -1,95 +1,95 @@
-Changes in version 2023.6.11
+# Changes in 2023.6.11
 
 - Remove maptools dependency.
 - split.x -> split_recursive to silence new CRAN check.
 - setDTthreads(1) in examples for CRAN.
 
-Changes in version 2023.3.14
+# Changes in 2023.3.14
 
 - Changes to satisfy CRAN (import is, consistent function args, graphical-units.Rd, rm Fox book URL in stat_ellipse.Rd).
 - facet and plot title text size configurable via theme(strip.text, axis.text).
 
-Changes in version 2022.9.14
+# Changes in 2022.9.14
 
 - Include Yufan Fei as contributor in DESCRIPTION.
 
-Changes in version 2022.9.14
+# Changes in 2022.9.14
 
 - Allow configurable legend/axis text size via theme.
 
-Changes in version 2022.8.31
+# Changes in 2022.8.31
 
 - User-configurable selection styles, alpha_off and colour_off.
 
-Changes in version 2022.8.25
+# Changes in 2022.8.25
 
 - import data.table, for faster compilation.
 
-Changes in version 2022.5.25
+# Changes in 2022.5.25
 
 - Add ability to rotate geom_text labels, following ggplot2's semantics of rotation direction. 
 
-Changes in version 2022.5.24
+# Changes in 2022.5.24
 
 - Fixed small test regression and set up Github Actions. Neither of these is user facing.
 
-Changes in version 2022.2.2
+# Changes in 2022.2.2
 
 - Default x/y axis text size increased to 16px from 11px in animint.js.
 - Suggest RColorBrewer to avoid CRAN NOTE "Undeclared package RColorBrewer in Rd xrefs".
 
-Changes in version 2022.1.25
+# Changes in 2022.1.25
 
 - Remove geom/stat_boxplot/quantile due to errors from CRAN check.
 
-Changes in version 2020.9.18
+# Changes in 2020.9.18
 
 - update moved mcmaster URL in docs.
 
-Changes in version 2020.8.19
+# Changes in 2020.8.19
 
 - Move geom-specific code from saveLayer/if-else to Geom$export_animint and pre_process methods in Geom sub-classes.
 
-Changes in version 2020.7.9
+# Changes in 2020.7.9
 
-- Using RSelenium Version 1.7.4.
+- Using RSelenium 1.7.4.
 - Removed Defunct and Redundant code/examples.
 - User can test using docker to avoid incompatibility issues.
 - imports knitr as knit_print imported in namespace.
 - Use new grid::unitType() to determine unit type of margin in pt/points to line conversion.
 
-Changes in version 2020.3.2
+# Changes in 2020.3.2
 
 - data.frame(stringsAsFactors=TRUE) in tests.
 
-Changes in version 2019.7.12
+# Changes in 2019.7.12
 
 - Added three authors which are mentioned in Rd/R files.
 
-Changes in version 2019.7.3
+# Changes in 2019.7.3
 
 - ggsave(file.path(tempdir(), f)) in examples.
 
-Changes in version 2019.7.2
+# Changes in 2019.7.2
 
 - animint2dir writes to temp dir rather than user dir during examples/tests.
 
-Changes in version 2019.6.4
+# Changes in 2019.6.4
 
 - bugfix for facet_grid(scales/space="free")
 - bugfix for update_axes with geom_abline
 - bugfix for graph height computation, which only showed up when there were lots of rows in the facet spec.
 
-Changes in version 2018.12.14
+# Changes in 2018.12.14
 
 - animint fun, export print method.
 - infinite values converted to range min/max before saving tsv files.
 
-Changes in version 2018.10.4
+# Changes in 2018.10.4
 
 - DEP: no longer depend on any branch of ggplot2.
 - train_layout from ggplot2 - R/panel.r function is now g_train_layout. train_layout from animint2 - R/z_facet.R function is the same. Both are internal functions.
 
-Changes in version 2017.08.24
+# Changes in 2017.08.24
 
 - DSL: clickSelects/showSelected are now specified as parameters rather than aesthetics.

README.md

@@ -0,0 +1,52 @@
+# Animint2
+
+<a href="https://github.com/tdhock/animint2/actions/workflows/tests.yaml">
+	<img src="https://github.com/tdhock/animint2/actions/workflows/tests.yaml/badge.svg" 
+	     alt="A badge verifying if this package has passed all its tests.">
+</a>
+<!-- Feel free to change the HTML block above this comment into Markdown. It's just in HTML cuz I couldn't be arsed to figure out how to correctly combine an image and a link in Github-flavored Markdown. -->
+
+
+
+## About
+
+Animint2 is an R package for generating and sharing interactive data visualizations, sometimes referred to as animints. It is a fork of, and uses similar syntax to, [ggplot2](https://ggplot2.tidyverse.org/). Animint2 is especially useful for large datasets, but smaller datasets can be made interactive, too. It is also capable of generating static data visualizations.
+
+Play around with this interactive data visualization of [data from the World Bank](https://rcdata.nau.edu/genomic-ml/WorldBank-facets/). For more examples, go to the [animint gallery](https://rcdata.nau.edu/genomic-ml/animint-gallery/).
+
+To learn how to generate your own interactive data visualizations, go to the official [Animint2 Manual](https://rcdata.nau.edu/genomic-ml/animint2-manual/Ch00-preface.html). If you encounter problems, please see the [animint2 wiki](https://github.com/animint/animint2/wiki) or [report them](https://github.com/animint/animint2/issues).
+
+<img src="man/figures/world_bank_screencast.gif" alt="A screencast of an interactive data visualization displaying fertility data from the World Bank. The user types in the selection menu and clicks on the legend, which causes changes in the visualization. GIF."> <!-- If you're familiar with Markdown, you may be wondering why I've elected to use HTML here instead of using the conventional ![alt text](source). It's cuz R's pkgdown package renders the alt text as both alt text and a fig caption. That's redundant. Using <img> ensures that it comes out the way we want. -->
+
+
+## Installation
+
+``` r
+# Install the official package from CRAN.
+# This is the option most people should choose:
+install.packages("animint2")
+
+# If you want to install the development version:
+devtools::install_github("animint/animint2")
+```
+
+
+## Use
+
+Animint2 uses the same implementation of `ggplot2`’s grammar of graphics—with a few additions. If you’re familiar with `ggplot2`, using `animint2` will be easy. If you’re not, no worries. To get started, see the brief [Animint2 Quick Start Guide](vignettes/starter-kit.html) or read the first few chapters of the [Animint2 Manual](https://rcdata.nau.edu/genomic-ml/animint2-manual/Ch00-preface.html).
+
+`animint2` renders and animates data visualizations. It can neither manipulate the datasets you give it nor generate its own data.
+
+
+## Similar Packages
+
+`animint2` isn’t the only R package that can create animated or interactive data visualizations.
+
+[animation](https://cran.r-project.org/package=animation) and [gganimate](https://cloud.r-project.org/web/packages/gganimate/index.html) can animate changes between variables over time. The [loon](https://cran.r-project.org/package=loon) package specializes in exploratory data analysis. [plotly](https://cran.r-project.org/package=plotly) is probably most similar to animint2 in terms of functionality.
+
+For comparisons between the aforementioned packages and `animint2`, see [the differences wiki page](https://github.com/animint/animint2/wiki/Differences-with-other-packages).
+
+
+## Problems?
+
+The `animint2` package is a work in progress. If you spot any bugs or unexpected behaviors, please let us know by [reporting it as an issue on GitHub](https://github.com/animint/animint2/issues). Thanks! Have a great day.