chronochrt

R package ChronochRt - building chronological charts easily with R

https://gitlab.com/archaeothommy/chronochrt

Science Score: 41.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

R package ChronochRt - building chronological charts easily with R

Basic Info
  • Host: gitlab.com
  • Owner: archaeothommy
  • License: gpl-3.0
  • Default Branch: master
Statistics
  • Stars: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created almost 7 years ago
Metadata Files
Readme License Citation

README.Rmd

---
output: github_document
---



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

# ChronochRt


[![pipeline status](https://gitlab.com/archaeothommy/chronochrt/badges/master/pipeline.svg)](https://gitlab.com/archaeothommy/chronochrt/-/commits/master)
[![coverage report](https://gitlab.com/archaeothommy/chronochrt/badges/master/coverage.svg)](https://gitlab.com/archaeothommy/chronochrt/-/commits/master)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/chronochrt)](https://cran.r-project.org/package=chronochrt)
[![CRAN_downloads](https://cranlogs.r-pkg.org/badges/grand-total/chronochrt)](https://cran.r-project.org/package=chronochrt)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5154018.svg)](https://doi.org/10.5281/zenodo.5154018)


ChronochRt offers an easy way to draw chronological charts from tables. It aims to provide an intuitive environment for anyone new to R and includes [ggplot2](https://ggplot2.tidyverse.org/) geoms and theme for chronological charts. 

## Installation

You can install the released version of ChronochRt from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("chronochrt")
```
or install the development version with the newest bugfixes and features from gitlab with:

``` r
 devtools::install_gitlab("archaeothommy/chronochrt")
```

Please help us to improve ChronochRt by filing observed bugs as an issue [here](mailto:incoming+archaeothommy-chronochrt-13993341-issue-@incoming.gitlab.com).

## Features

* Slim structure of chronological datasets
* Import tabular data files 
* Import Excel files (requires the package [readxl](https://readxl.tidyverse.org/))
* Possibility to display up to 2 chronological systems within the same region (e.g. long and short chronologies)
* Layout of the chronological chart optimised for easy readability and comprehensibility
* Years in BCE must be negative - that's all you need to care about dates
* Handling of insecure dates
* Handling of gaps, e.g. abandonment phases of sites
* Optional text labels
* Optional image labels to e.g. display key finds or show typological developments
* Geoms for the chronological chart and image labels
* Export of the chronological chart in different file formats (raster and vector graphics)
* Easy customisation of the chronological chart
* Based on the [tidyverse](https://www.tidyverse.org/): Seamless integration in pipes, enhanced customisation with [ggplot2](https://ggplot2.tidyverse.org/) 

Is there a feature missing? Please let us know [here](mailto:incoming+archaeothommy-chronochrt-13993341-issue-@incoming.gitlab.com).

## Example

```r
library(ChronochRt)

data <- add_chron(region = "A",
                  name = c("A", "A1", "A2", "B"),
                  start = c(-200, -200, 0, -100),
                  end = c(200, 0, 200, 100),
                  level = c(1,2,2,1),
                  add = FALSE,
                  new_table = TRUE)

plot_chronochrt(data)
```

## Getting started

* [Cheatsheet](https://gitlab.com/archaeothommy/chronochrt/-/raw/master/inst/ChronochRt_Cheatsheet.pdf?inline=false)
* [Vignettes](https://gitlab.com/archaeothommy/chronochrt/-/tree/master/vignettes)

## Funding for the development of ChronochRt 0.0.5

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under the Marie Skłodowska-Curie grant agreement No 766311.

Citation (CITATION.cff)

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.2.2
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------

cff-version: 1.2.0
message: 'To cite package "chronochrt" in publications use:'
type: software
license: GPL-3.0-only
title: 'chronochrt: Creating Chronological Charts'
version: 0.1.3
date-released: '2024-01-14'
abstract: Easy way to draw chronological charts from tables, aiming to include an
  intuitive environment for anyone new to R. Includes 'ggplot2' geoms and theme for
  chronological charts.
authors:
- family-names: Rose
  given-names: Thomas
  email: thomas.rose@daad-alumni.de
  orcid: https://orcid.org/0000-0002-8186-3566
- family-names: Girotto
  given-names: Chiara
  email: chiara.girotto@web.de
  orcid: https://orcid.org/0000-0001-6412-342X
preferred-citation:
  type: manual
  title: 'chronochrt: Creating Chronological Charts'
  authors:
  - family-names: Rose
    given-names: Thomas
    email: thomas.rose@daad-alumni.de
    orcid: https://orcid.org/0000-0002-8186-3566
  - family-names: Girotto
    given-names: Chiara
    email: chiara.girotto@web.de
    orcid: https://orcid.org/0000-0001-6412-342X
  version: 0.1.3
  abstract: Easy way to draw chronological charts from tables, aiming to include an
    intuitive environment for anyone new to R. Includes 'ggplot2' geoms and theme
    for chronological charts.
  repository: https://CRAN.R-project.org/package=chronochrt
  repository-code: https://gitlab.com/archaeothommy/chronochrt
  url: https://gitlab.com/archaeothommy/chronochrt
  date-released: '2024-01-14'
  contact:
  - family-names: Rose
    given-names: Thomas
    email: thomas.rose@daad-alumni.de
    orcid: https://orcid.org/0000-0002-8186-3566
  license: GPL-3.0-only
  year: '2024'
repository: https://CRAN.R-project.org/package=chronochrt
repository-code: https://gitlab.com/archaeothommy/chronochrt
url: https://gitlab.com/archaeothommy/chronochrt
contact:
- family-names: Rose
  given-names: Thomas
  email: thomas.rose@daad-alumni.de
  orcid: https://orcid.org/0000-0002-8186-3566
references:
- type: software
  title: dplyr
  abstract: 'dplyr: A Grammar of Data Manipulation'
  notes: Imports
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: François
    given-names: Romain
    orcid: https://orcid.org/0000-0002-2444-4226
  - family-names: Henry
    given-names: Lionel
  - family-names: Müller
    given-names: Kirill
    orcid: https://orcid.org/0000-0002-1416-3412
  year: '2022'
  url: https://CRAN.R-project.org/package=dplyr
  version: '>= 1.0.0'
- type: software
  title: ggplot2
  abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
  notes: Imports
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: Chang
    given-names: Winston
    orcid: https://orcid.org/0000-0002-1576-2126
  - family-names: Henry
    given-names: Lionel
  - family-names: Pedersen
    given-names: Thomas Lin
    email: thomas.pedersen@rstudio.com
    orcid: https://orcid.org/0000-0002-5147-4711
  - family-names: Takahashi
    given-names: Kohske
  - family-names: Wilke
    given-names: Claus
    orcid: https://orcid.org/0000-0002-7470-9261
  - family-names: Woo
    given-names: Kara
    orcid: https://orcid.org/0000-0002-5125-4188
  - family-names: Yutani
    given-names: Hiroaki
    orcid: https://orcid.org/0000-0002-3385-7233
  - family-names: Dunnington
    given-names: Dewey
    orcid: https://orcid.org/0000-0002-9415-4582
  year: '2022'
  url: https://CRAN.R-project.org/package=ggplot2
- type: software
  title: grid
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  location:
    name: Vienna, Austria
  year: '2022'
  url: https://www.R-project.org/
  institution:
    name: R Foundation for Statistical Computing
- type: software
  title: magick
  abstract: 'magick: Advanced Graphics and Image-Processing in R'
  notes: Imports
  authors:
  - family-names: Ooms
    given-names: Jeroen
    email: jeroen@berkeley.edu
    orcid: https://orcid.org/0000-0002-4035-0289
  year: '2022'
  url: https://CRAN.R-project.org/package=magick
- type: software
  title: magrittr
  abstract: 'magrittr: A Forward-Pipe Operator for R'
  notes: Imports
  authors:
  - family-names: Bache
    given-names: Stefan Milton
    email: stefan@stefanbache.dk
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2022'
  url: https://CRAN.R-project.org/package=magrittr
- type: software
  title: readr
  abstract: 'readr: Read Rectangular Text Data'
  notes: Imports
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  - family-names: Hester
    given-names: Jim
  - family-names: Bryan
    given-names: Jennifer
    email: jenny@rstudio.com
    orcid: https://orcid.org/0000-0002-6983-2759
  year: '2022'
  url: https://CRAN.R-project.org/package=readr
- type: software
  title: tibble
  abstract: 'tibble: Simple Data Frames'
  notes: Imports
  authors:
  - family-names: Müller
    given-names: Kirill
    email: krlmlr+r@mailbox.org
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2022'
  url: https://CRAN.R-project.org/package=tibble
- type: software
  title: tidyr
  abstract: 'tidyr: Tidy Messy Data'
  notes: Imports
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  - family-names: Girlich
    given-names: Maximilian
  year: '2022'
  url: https://CRAN.R-project.org/package=tidyr
- type: software
  title: rlang
  abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features'
  notes: Imports
  authors:
  - family-names: Henry
    given-names: Lionel
    email: lionel@rstudio.com
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2022'
  url: https://CRAN.R-project.org/package=rlang
- type: software
  title: tidyselect
  abstract: 'tidyselect: Select from a Set of Strings'
  notes: Imports
  authors:
  - family-names: Henry
    given-names: Lionel
    email: lionel@rstudio.com
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2022'
  url: https://CRAN.R-project.org/package=tidyselect
- type: software
  title: readxl
  abstract: 'readxl: Read Excel Files'
  notes: Suggests
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: Bryan
    given-names: Jennifer
    email: jenny@rstudio.com
    orcid: https://orcid.org/0000-0002-6983-2759
  year: '2022'
  url: https://CRAN.R-project.org/package=readxl
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2022'
  url: https://CRAN.R-project.org/package=testthat
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2022'
  url: https://CRAN.R-project.org/package=knitr
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@rstudio.com
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@rstudio.com
  - family-names: Luraschi
    given-names: Javier
    email: javier@rstudio.com
  - family-names: Ushey
    given-names: Kevin
    email: kevin@rstudio.com
  - family-names: Atkins
    given-names: Aron
    email: aron@rstudio.com
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  - family-names: Cheng
    given-names: Joe
    email: joe@rstudio.com
  - family-names: Chang
    given-names: Winston
    email: winston@rstudio.com
  - family-names: Iannone
    given-names: Richard
    email: rich@rstudio.com
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2022'
  url: https://CRAN.R-project.org/package=rmarkdown
- type: software
  title: covr
  abstract: 'covr: Test Coverage for Packages'
  notes: Suggests
  authors:
  - family-names: Hester
    given-names: Jim
    email: james.f.hester@gmail.com
  year: '2022'
  url: https://CRAN.R-project.org/package=covr
- type: software
  title: vdiffr
  abstract: 'vdiffr: Visual Regression Testing and Graphical Diffing'
  notes: Suggests
  authors:
  - family-names: Henry
    given-names: Lionel
    email: lionel@rstudio.com
  - family-names: Pedersen
    given-names: Thomas Lin
    email: thomas.pedersen@rstudio.com
    orcid: https://orcid.org/0000-0002-5147-4711
  - family-names: Luciani
    given-names: T Jake
    email: jake@apache.org
  - family-names: Decorde
    given-names: Matthieu
    email: matthieu.decorde@ens-lyon.fr
  - family-names: Lise
    given-names: Vaudor
    email: lise.vaudor@ens-lyon.fr
  year: '2022'
  url: https://CRAN.R-project.org/package=vdiffr

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 150
  • Total Committers: 3
  • Avg Commits per committer: 50.0
  • Development Distribution Score (DDS): 0.187
Past Year
  • Commits: 6
  • Committers: 1
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Thomas Rose t****e@d****e 122
Chiara Girotto c****o@w****e 15
roset t****e@d****e 13
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

Packages

  • Total packages: 1
  • Total downloads:
    • cran 266 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
cran.r-project.org: chronochrt

Creating Chronological Charts

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 266 Last month
Rankings
Forks count: 28.8%
Dependent packages count: 29.8%
Stargazers count: 31.7%
Average: 35.4%
Dependent repos count: 35.5%
Downloads: 51.5%
Maintainers (1)
Last synced: 11 months ago