-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
145 lines (112 loc) · 5.33 KB
/
Copy pathREADME.Rmd
File metadata and controls
145 lines (112 loc) · 5.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
---
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.setenv(LANGUAGE = "en") # Force locale
```
# kinesis <img width=120px src="man/figures/logo.png" align="right" />
<!-- badges: start -->
[](https://ci.codeberg.org/repos/14694){.pkgdown-devel}
[](https://packages.tesselle.org/kinesis/coverage/){.pkgdown-devel}
[](https://cran.r-project.org/package=kinesis){.pkgdown-devel}
[](https://tesselle.r-universe.dev/kinesis){.pkgdown-devel}
[](https://cran.r-project.org/package=kinesis){.pkgdown-release}
[](https://cran.r-project.org/web/checks/check_results_kinesis.html){.pkgdown-release}
[](https://cran.r-project.org/package=kinesis){.pkgdown-release}
[](https://www.repostatus.org/#wip)
[](https://doi.org/10.5281/zenodo.14645671)
[](https://archive.softwareheritage.org/browse/origin/?origin_url=https://codeberg.org/tesselle/kinesis)
<!-- badges: end -->
## Overview
A collection of [**shiny**](https://shiny.posit.co) 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 at <https://shiny.archaeo.science>.
## Local use
### Installation
You can install the released version of **kinesis** from [CRAN](https://CRAN.R-project.org) with:
```{r cran-installation, eval=FALSE}
install.packages("kinesis")
```
And the development version from [Codeberg](https://codeberg.org/) with:
```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_git("https://codeberg.org/tesselle/kinesis")
```
### Usage
```{r shiny, eval=FALSE}
## Load the package
library(kinesis)
## Run the app for matrix seriation
run_app("seriation")
```
| Keyword | Application name |
|:------------|:------------------------------|
| `aoristic` | Aoristic Analysis |
| `ca` | Correspondence Analysis |
| `pca` | Principal Components Analysis |
| `diversity` | Diversity Measures |
| `mcd` | Mean Ceramic Date |
| `scatter` | Scatter Plot |
| `seriation` | Matrix Seriation |
| `source` | Compositional Data Analysis |
| `ternary` | Ternary Plot |
### Asynchronous backend
```{r mirai, eval=FALSE}
## Run app using 3 local daemons
# install.packages("mirai")
obj <- run_app("seriation")
with(mirai::daemons(3), shiny::runApp(obj))
```
## Translation
This package provides translations of the user interface. The preferred language is by default taken from the locale. This can be overridden by setting of the environment variable `LANGUAGE` (you only need to do this once per session):
``` r
Sys.setenv(LANGUAGE = "<language code>")
```
Languages currently available are English (`en`) and French (`fr`).
## 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.
```{r metadata, include=FALSE}
## Update codemeta.json
codemetar::write_codemeta(verbose = FALSE)
## Update CITATION.cff
cff_keys <- list(
identifiers = list(
list(description = "The concept DOI.",
type = "doi",
value = "10.5281/zenodo.14645671"),
list(description = "The versioned DOI for version 0.1.0.",
type = "doi",
value = "10.5281/zenodo.14645672"),
list(description = "The versioned DOI for version 0.2.0.",
type = "doi",
value = "10.5281/zenodo.15784615"),
list(description = "The versioned DOI for version 0.2.1.",
type = "doi",
value = "10.5281/zenodo.15918746"),
list(description = "The versioned DOI for version 0.3.0.",
type = "doi",
value = "10.5281/zenodo.17177309"),
list(description = "The versioned DOI for version 0.3.1.",
type = "doi",
value = "10.5281/zenodo.17232778"),
list(description = "The CRAN DOI",
type = "doi",
value = "10.32614/CRAN.package.kinesis")
)
)
cff <- cffr::cff_create("DESCRIPTION", keys = cff_keys)
if (cffr::cff_validate(cff)) cffr::cff_write(cff, outfile = "CITATION.cff")
```