Data

Tools

Indexes

Applications

Experiments

Open Source Science

detourr

Animations for {tourr} using htmlwidgets for performance and portability.

https://github.com/casperhart/detourr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Animations for {tourr} using htmlwidgets for performance and portability.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 5
  • Forks: 4
  • Open Issues: 2
  • Releases: 0
Created over 5 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.Rmd 

---
output:
  github_document:
    html_preview: false
---



# detourr 

Animations for {tourr} using htmlwidgets for performance and portability.

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/",
  out.width = "100%"
)
```

# Installation

Install this package by running the following in R:

```{r, eval=FALSE}
remotes::install_github("casperhart/detourr")
``` 

# Examples

```{r, eval=FALSE}
# 2D scatter
library(tourr)
library(detourr)
detour(olive, tour_aes(projection = palmitic:eicosenoic, colour = region)) |>
  show_scatter()
```

```{r, eval=FALSE}
# 3D scatter
detour(olive, tour_aes(projection = palmitic:eicosenoic, colour = region)) |>
  tour_path(grand_tour(3)) |>
  show_scatter()
```

# Development

## Getting Started

This project uses TypeScript code which needs to be compiled and bundled for
the package to work. To do this, you will need `node.js`, and `yarn`
installed.

After cloning this repository, you can install the node.js dependencies via:

```{bash, eval=FALSE}
yarn install
```

Compile and bundle the TypeScript code and install the R package from source by
running:

```{bash, eval=FALSE}
yarn run build
```

The TypeScript code which powers the HTMLWidgets can also be run as a
standalone app using `webpack-dev-server` as follows:

```{bash, eval=FALSE}
yarn run start-dev
```

This will start the webpack dev server, which will automatically recompile and
reload the TypeScript code as changes are made.
The sample data and HTML used by the dev server can be found in `./dev`, and
are loaded in to memory based on the configuration in `webpack/dev.config.ts`

If you wish to make changes to the HTML files in `dev/`, or debug the
`yarn run start-dev` command, you can instead run `yarn run build-dev`.
This will load the files in `dev/` in to a folder called `dev_build/` rather
than in to memory, which can make debugging easier.

Owner

  • Login: casperhart
  • Kind: user

GitHub Events

Total
  • Create event: 5
  • Issues event: 13
  • Watch event: 1
  • Delete event: 5
  • Member event: 1
  • Issue comment event: 14
  • Push event: 12
  • Pull request event: 12
  • Pull request review event: 10
  • Pull request review comment event: 15
Last Year
  • Create event: 5
  • Issues event: 13
  • Watch event: 1
  • Delete event: 5
  • Member event: 1
  • Issue comment event: 14
  • Push event: 12
  • Pull request event: 12
  • Pull request review event: 10
  • Pull request review comment event: 15

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 155
  • Total Committers: 3
  • Avg Commits per committer: 51.667
  • Development Distribution Score (DDS): 0.013
Top Committers
Name Email Commits
casperhart c****3@g****m 153
Mark Greenaway c****f@g****m 1
casperhart 3****t@u****m 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 57
  • Total pull requests: 51
  • Average time to close issues: 3 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 2.35
  • Average comments per pull request: 2.55
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 6
  • Average time to close issues: 6 days
  • Average time to close pull requests: 5 months
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 3.0
  • Average comments per pull request: 1.67
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • casperhart (31)
  • earowang (20)
  • dicook (3)
  • Corlio5994 (2)
  • GabrielMccoy (1)
Pull Request Authors
  • casperhart (52)
  • janithwanni (6)
  • certifiedwaif (1)
Top Labels
Issue Labels
documentation (7) enhancement (2) bug (2) good first issue (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 269 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: detourr

Portable and Performant Tour Animations

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 269 Last month
Rankings
Forks count: 14.9%
Stargazers count: 18.7%
Dependent packages count: 29.8%
Average: 35.4%
Dependent repos count: 35.5%
Downloads: 78.1%
Maintainers (1)
casperhart93@gmail.com
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • R >= 4.1 depends
  • grDevices * imports
  • htmlwidgets * imports
  • purrr * imports
  • rlang * imports
  • tibble * imports
  • tidyselect * imports
  • tourr * imports
  • viridisLite * imports
  • crosstalk * suggests
  • dplyr * suggests
  • geozoo * suggests
  • htmltools * suggests
  • knitr * suggests
  • liminal * suggests
  • rmarkdown * suggests
  • shiny * suggests
  • testthat >= 3.0.0 suggests
package.json npm
  • @babel/core ^7.14.3 development
  • @babel/register ^7.13.16 development
  • @types/three ^0.129.1 development
  • @typescript-eslint/eslint-plugin latest development
  • @typescript-eslint/parser ^5.10.1 development
  • copy-webpack-plugin ^9.0.0 development
  • css-loader ^6.0.0 development
  • eslint ^8.8.0 development
  • eslint-config-prettier ^8.3.0 development
  • prettier ^2.5.1 development
  • style-loader ^3.1.0 development
  • ts-loader ^9.1.2 development
  • typescript ^4.2.4 development
  • webpack ^5.35.1 development
  • webpack-cli ^4.6.0 development
  • webpack-dev-server ^4.8.1 development
  • @stdlib/math-base-special-betainc ^0.0.6
  • @tensorflow/tfjs-backend-wasm ^3.15.0
  • @tensorflow/tfjs-core ^3.15.0
  • three ^0.128.0
  • url-loader ^4.1.1
yarn.lock npm
  • 678 dependencies
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite