Skip to content

tesselle/kinesis

Repository files navigation

kinesis

R-CMD-check codecov

r-universe Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Overview

A collection of shiny applications that provides graphical user interfaces for the tesselle packages.

This package is currently experimental. This means that it is functional, but interfaces and functionalities may change over time, testing and documentation may be lacking.


To cite kinesis in publications use:

Frerebeau N (2024). “The tesselle Project: a Collection of R Packages for Research and Teaching in Archaeology.” Advances in Archaeological Practice. doi:10.1017/aap.2024.10 https://doi.org/10.1017/aap.2024.10.

Frerebeau N (2024). kinesis: ‘shiny’ Applications for the ‘tesselle’ Packages. Université Bordeaux Montaigne, Pessac, France. R package version 0.0.0.9004, https://packages.tesselle.org/kinesis/.

This package is a part of the tesselle project https://www.tesselle.org.

Remote use

The applications are deployed on the Huma-Num Shiny server: https://analytics.huma-num.fr/tesselle/home/.

Local use

Installation

You can install the released version of kinesis from our repository with:

options(repos = c(CRAN = "https://cloud.r-project.org",
                  tesselle = "https://tesselle.r-universe.dev"))

install.packages("kinesis")

And the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("tesselle/kinesis")

Usage

## Load the package
library(kinesis)

## Run the app for matrix seriation
run_app("seriate")

Contributing

Please note that the kinesis project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.