Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Sep 20, 2024
1 parent 2c272dd commit c7b98e6
Showing 1 changed file with 1 addition and 24 deletions.
25 changes: 1 addition & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,3 @@
# packages

Most of the R packages of the [tesselle](https://www.tesselle.org/) project are distributed on [CRAN](https://cran.r-project.org/), but some data packages are too large and can only be installed from our universe: [tesselle.r-universe.dev](https://tesselle.r-universe.dev).

If available, CRAN releases must be regarded as the preferred source.

## Download tesselle packages

If you want to install a package, simply use `install.packages()` with the additional repository:

``` r
## Enable this universe
options(repos = c(CRAN = 'https://cloud.r-project.org'),
tesselle = 'https://tesselle.r-universe.dev')

## Install some packages
install.packages("tabula")
```

## Use the repository

You can use this repository in your R package (always prefer the CRAN release if available). To do so, prepare the `DESCRIPTION` file of your R package:

* List the package under `Suggests:`
* Add the line `Additional_repositories: https://tesselle.r-universe.dev`
* Test your package with `R CMD check --as-cran`
This is the repository for the [packages portal](https://packages.tesselle.org).

0 comments on commit c7b98e6

Please sign in to comment.