Get Started

Start using the tesselle packages.

Download and install

The tesselle packages can be downloaded and installed from CRAN.

A meta-package, called tesselle, lets you download and install the project’s packages with a single R command:

install.packages("tesselle")

Using the library() function, you can then attach the core tesselle packages:

#> --- Attaching packages -------------------------------------------- tesselle ---
#> * tabula    3.1.1
#> * kairos    2.1.1
#> * nexus     0.3.0

These core packages can be used to explore and analyze common data types in archaeology: count data (tabula), compositional data (nexus) and chronological data (kairos).

Thanks to the R-universe project powered by rOpenSci, tesselle has its own CRAN-like repository: tesselle.r-universe.dev. This repository allows to install all versions and non-CRAN packages (e.g. WIP packages and large data packages). If you want to download and install a package from it, simply use install.packages() and specify the repository URL:

## Install a package from the 'tesselle' universe
install.packages("tabula", repos = "https://tesselle.r-universe.dev")
## Enable the repository globally
options(repos = c(tesselle = "https://tesselle.r-universe.dev",
                  CRAN = "https://cloud.r-project.org"))

## Install some packages
install.packages(c("tabula", "kairos"))

How to cite

If you use the tesselle packages in your publications, you must report and cite them properly (as with any other research software) to ensure transparency and reproducibility of your results. By doing so, published results are linked to a particular version of the software, ensuring traceability in case an error is discovered later.

Citing packages can encourage further development and improvement of these tools. Package authors and maintainers are more likely to continue their work if they see that it’s being used and valued by the research community. By citing their work, you’re providing a form of recognition, giving package authors and contributors proper credit for their time and efforts.

Use the citation() function for information on how to cite the base R system or any non-base package:

## Get the basic R reference
citation()
#> To cite R in publications use:
#> 
#>   R Core Team (2024). _R: A Language and Environment for Statistical
#>   Computing_. R Foundation for Statistical Computing, Vienna, Austria.
#>   <https://www.R-project.org/>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {R: A Language and Environment for Statistical Computing},
#>     author = {{R Core Team}},
#>     organization = {R Foundation for Statistical Computing},
#>     address = {Vienna, Austria},
#>     year = {2024},
#>     url = {https://www.R-project.org/},
#>   }
#> 
#> We have invested a lot of time and effort in creating R, please cite it
#> when using it for data analysis. See also 'citation("pkgname")' for
#> citing R packages.
## Get the reference of the tesselle meta-package
citation("tesselle")
#> To cite tesselle in publications use:
#> 
#>   Frerebeau N (2023). _tesselle: Easily Install and Load 'tesselle'
#>   Packages_. Université Bordeaux Montaigne, Pessac, France.
#>   doi:10.5281/zenodo.6500491 <https://doi.org/10.5281/zenodo.6500491>,
#>   R package version 1.4.0, <https://packages.tesselle.org/tesselle/>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     author = {Nicolas Frerebeau},
#>     title = {{tesselle: Easily Install and Load 'tesselle' Packages}},
#>     year = {2023},
#>     organization = {Université Bordeaux Montaigne},
#>     address = {Pessac, France},
#>     note = {R package version 1.4.0},
#>     url = {https://packages.tesselle.org/tesselle/},
#>     doi = {10.5281/zenodo.6500491},
#>   }
#> 
#> This package is a part of the tesselle project
#> <https://www.tesselle.org>.