Skip to content
This repository has been archived by the owner on Jan 30, 2025. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Nov 8, 2022
1 parent b0074b3 commit 586b556
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 8 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Suggests:
khroma,
knitr,
rmarkdown,
tabula (>= 2.0.0),
testthat (>= 3.0.0),
vdiffr (>= 1.0.0)
VignetteBuilder:
Expand Down
21 changes: 20 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ knitr::opts_chunk$set(

[![r-universe](https://tesselle.r-universe.dev/badges/kairos)](https://tesselle.r-universe.dev){.pkgdown-devel}
[![CRAN Version](http://www.r-pkg.org/badges/version/kairos)](https://cran.r-project.org/package=kairos){.pkgdown-release}
[![CRAN checks](https://cranchecks.info/badges/worst/kairos)](https://cran.r-project.org/web/checks/check_results_kairos.html){.pkgdown-release}
[![CRAN checks](https://badges.cranchecks.info/worst/kairos.svg)](https://cran.r-project.org/web/checks/check_results_kairos.html){.pkgdown-release}
[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/kairos)](https://cran.r-project.org/package=kairos){.pkgdown-release}

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
Expand Down Expand Up @@ -91,6 +91,25 @@ tabula::plot_heatmap(incidence2) +
khroma::scale_fill_logical()
```

```{r aoristic, fig.width=5, fig.height=6}
## Aoristic Analysis
data("loire", package = "folio")
loire <- subset(loire, area %in% c("Anjou", "Blésois", "Orléanais", "Haut-Poitou", "Touraine"))
## Get time range
loire_range <- loire[, c("lower", "upper")]
## Calculate aoristic sum (weights) by group
aorist_groups <- aoristic(loire_range, step = 50, weight = TRUE,
groups = loire$area)
plot(aorist_groups)
## Rate of change by group
roc_groups <- roc(aorist_groups, n = 30)
plot(roc_groups)
```


## Contributing

Please note that the **kairos** 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.
Expand Down
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ src="http://www.r-pkg.org/badges/version/kairos"
alt="CRAN Version" /></a> <a
href="https://cran.r-project.org/web/checks/check_results_kairos.html"
class="pkgdown-release"><img
src="https://cranchecks.info/badges/worst/kairos"
src="https://badges.cranchecks.info/worst/kairos.svg"
alt="CRAN checks" /></a>
<a href="https://cran.r-project.org/package=kairos"
class="pkgdown-release"><img
Expand Down Expand Up @@ -107,18 +107,37 @@ incidence2 <- permute(incidence1, indices)
## Plot matrix
tabula::plot_heatmap(incidence1) +
khroma::scale_fill_logical()
#> Warning: 'as_long()' est obsolète.
#> Utilisez plutôt ‘to_long()’.
#> Voir help("Deprecated")
tabula::plot_heatmap(incidence2) +
khroma::scale_fill_logical()
#> Warning: 'as_long()' est obsolète.
#> Utilisez plutôt ‘to_long()’.
#> Voir help("Deprecated")
```

<img src="man/figures/README-seriation-1.png" width="50%" /><img src="man/figures/README-seriation-2.png" width="50%" />

``` r
## Aoristic Analysis
data("loire", package = "folio")
loire <- subset(loire, area %in% c("Anjou", "Blésois", "Orléanais", "Haut-Poitou", "Touraine"))

## Get time range
loire_range <- loire[, c("lower", "upper")]

## Calculate aoristic sum (weights) by group
aorist_groups <- aoristic(loire_range, step = 50, weight = TRUE,
groups = loire$area)
plot(aorist_groups)
```

![](man/figures/README-aoristic-1.png)<!-- -->

``` r

## Rate of change by group
roc_groups <- roc(aorist_groups, n = 30)
plot(roc_groups)
```

![](man/figures/README-aoristic-2.png)<!-- -->

## Contributing

Please note that the **kairos** project is released with a [Contributor
Expand Down
Binary file added man/figures/README-aoristic-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/figures/README-aoristic-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-seriation-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-seriation-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 586b556

Please sign in to comment.