README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
Sys.setlocale("LC_MESSAGES", 'en_GB.UTF-8') # Force locale
```

# kinesis <img width=120px src="man/figures/logo.png" align="right" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/tesselle/kinesis/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tesselle/kinesis/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/tesselle/kinesis/graph/badge.svg?token=i2n7T978ex)](https://codecov.io/gh/tesselle/kinesis)

[![r-universe](https://tesselle.r-universe.dev/badges/kinesis)](https://tesselle.r-universe.dev/kinesis){.pkgdown-devel}
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
<!-- badges: end -->

## Overview

A collection of [**shiny**](https://shiny.rstudio.com) applications that provides graphical user interfaces for the [tesselle](https://www.tesselle.org) 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.

---

```{r citation, echo=FALSE, comment='', results='asis'}
cite <- utils::citation("kinesis")
print(cite, bibtex = FALSE)
```

## Remote use

The applications are deployed on the [Huma-Num](https://www.huma-num.fr) Shiny server: <https://analytics.huma-num.fr/tesselle/home/>.

## Local use
### Installation

You can install the released version of **kinesis** from [our repository](https://tesselle.r-universe.dev) with:

```{r universe-installation, eval=FALSE}
options(repos = c(CRAN = "https://cloud.r-project.org",
                  tesselle = "https://tesselle.r-universe.dev"))

install.packages("kinesis")
```

And the development version from [GitHub](https://github.com/) with:

```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_github("tesselle/kinesis")
```

### Usage

```{r shiny, eval=FALSE}
## 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](https://www.tesselle.org/conduct.html). By contributing to this project, you agree to abide by its terms.