Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eddelbuettel/drat

Drat R Archive Template
https://github.com/eddelbuettel/drat

cran r r-package repository repository-tools

Last synced: 29 days ago
JSON representation

Drat R Archive Template

Awesome Lists containing this project

README 

        
## drat: Drat R Archive Template



[![CI](https://github.com/eddelbuettel/drat/workflows/ci/badge.svg)](https://github.com/eddelbuettel/drat/actions?query=workflow%3Aci)

[![License](https://img.shields.io/badge/license-GPL%20%28%3E=%202%29-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-2.0.html)

[![CRAN](https://www.r-pkg.org/badges/version/drat)](https://cran.r-project.org/package=drat)

[![r-universe](https://eddelbuettel.r-universe.dev/badges/drat)](https://eddelbuettel.r-universe.dev/drat)

[![Dependencies](https://tinyverse.netlify.app/badge/drat)](https://cran.r-project.org/package=drat)

[![Downloads](https://cranlogs.r-pkg.org/badges/drat?color=brightgreen)](https://www.r-pkg.org/pkg/drat)

[![Last Commit](https://img.shields.io/github/last-commit/eddelbuettel/drat)](https://github.com/eddelbuettel/drat)

[![Documentation](https://img.shields.io/badge/documentation-is_here-blue)](https://eddelbuettel.github.io/drat/)

[![Fork](https://img.shields.io/badge/fork-this_instead-orange)](https://github.com/drat-base/drat)



> **drat**

>

> What cute people say when they are pissed off

>

> _"Oh Drat, i lost my wallet"_

>

> [Urban Dictionary](https://urbandictionary.com/define.php?term=drat)



### Nota Bene



Do **not** fork _this_ repo as a quick start towards creating your `drat`, fork [this

repo](https://github.com/drat-base/drat) instead. See below for more.



### Background



The R package ecosystem is one of the cornerstones of the success seen by R.

As of July 2020, over 16000 packages are on [CRAN](https://cran.r-project.org),

with about one thousand more at [BioConductor](https://www.bioconductor.org).



Support for multiple repositories is built deeply into R; mostly via the

(default) package `utils`. The

[`update.packages`](https://www.rdocumentation.org/packages/utils/functions/update.packages)

function (along with several others from the `utils` package) can be used with

ease for these three default repositories as well as many others. But it

seemed that support for _simple creation and use_ of local repositories was

missing.



[Drat](https://dirk.eddelbuettel.com/code/drat.html) tries to help here and supports two principal modes:



- *GitHub* by leveraging `gh-pages`

- *Other repos* by using other storage where you can write and provide html access



Please see the next section about how to get started, the package documentation, the

[drat package page](https://dirk.eddelbuettel.com/code/drat.html) or the

[blog section on drat](http://dirk.eddelbuettel.com/blog/code/drat/) for more.



### Getting Started



Do **not** fork _this_ repo as a quick start towards creating your `drat`, fork [this

repo](https://github.com/drat-base/drat) instead. See below for more.



See the vignettes



- [Drat FAQ](https://eddelbuettel.github.io/drat/vignettes/dratfaq/),

- [Drat for Package Authors](https://eddelbuettel.github.io/drat/vignettes/dratforauthors/),

- [Drat for Package Users](https://eddelbuettel.github.io/drat/vignettes/dratforusers/)

- [Drat Step by Step](https://eddelbuettel.github.io/drat/vignettes/dratstepbystep/)

- [Why Drat?](https://eddelbuettel.github.io/drat/vignettes/whydrat/)

- [Combining Drat and Travis](https://eddelbuettel.github.io/drat/vignettes/combiningdratandtravis/)

- [Drat Lightning Talk at useR!2015](https://dirk.eddelbuettel.com/papers/useR2015_drat.pdf)



for the FAQ, two principal uses cases, basic motivation and an overview / introduction.

The package documentation provides more details.  The

[drat package page](https://dirk.eddelbuettel.com/code/drat.html) has a longer

tutorial, and the

[blog section on drat](http://dirk.eddelbuettel.com/blog/code/drat/) has even

more.



Package documentation, help pages, vignettes, and more is also available

[here](https://eddelbuettel.github.io/drat/).



### Installation



The preferred approach is to install the released package from [CRAN](https://cran.r-project.org) via the standard



```{.r}

install.packages("drat")

```



command.



### Quick Start Towards Your Own Drat



`drat` comes with its own repo creation helper function

[`initRepo`](https://eddelbuettel.github.io/drat/man/initRepo/), but an even shorter path may be to

fork an existing repo.  This has been done numerous times with this original repo. However, over

time this repo accumulated code refinements along with more documentation making it a little

unwieldy. So we set up [dedicated repo](https://github.com/drat-base/drat) just to facilitate `drat`

forking.  Clone it, and you will have a ready-to-use `drat` repository.



### Status



The package has been available from [CRAN](https://cran.r-project.org) since

the Spring of 2015 and starting to get some use. Possible improvements,

additions and next steps are listed in the

[TODO.md](https://github.com/eddelbuettel/drat/blob/master/inst/TODO.md)

file.



A few drat repositories are starting to appear (besides this one). An incomplete list (looking at the direct forks as well as GitHub search):



 - [yutannihilation](https://github.com/yutannihilation/drat)

 - [gschofl](https://github.com/gschofl/drat/)

 - [csgillespie](https://github.com/csgillespie/drat)

 - [shabbychef](https://github.com/shabbychef/drat)

 - [RcppCore](https://github.com/RcppCore/drat)

 - [arilamstein](https://github.com/arilamstein/drat)

 - [piccolbo](https://github.com/piccolbo/drat)

 - [ghrr](https://github.com/ghrr/drat)

 - [cloudyr](https://cloudyr.github.io/drat/)

 - [dmlc](https://github.com/dmlc/drat)

 - [thospfuller](https://github.com/thospfuller/drat)



The [rOpenSci](https://ropensci.org) project uses

[drat](https://dirk.eddelbuettel.com/code/drat.html) to distribute their code

and has written a

[nice blog post](https://ropensci.org/blog/2015/08/04/a-drat-repository-for-ropensci/)

about it.



### Travis Integration



Colin Gillespie integrated [Travis CI](https://www.travis-ci.com) with drat, see his

[dratTravis](https://github.com/csgillespie/dratTravis) repository for more details, and the

contributed vignette [Combining Drat and Travis](https://eddelbuettel.github.io/drat/vignettes/combiningdratandtravis/)



### GitHub Actions



Mike Mahoney uses [drat](https://dirk.eddelbuettel.com/code/drat.html)

with [GitHub Actions in a 'push' setting](https://www.mm218.dev/posts/2021-09-22-automated-drat-uploads-with-github-actions/),

while Zhian Kamvar uses [drat](https://dirk.eddelbuettel.com/code/drat.html)

with [GitHub Actions in a 'pull' setting](https://zkamvar.netlify.app/blog/gh-drat/).



### Author



Dirk Eddelbuettel, with contributions by Felix Ernst, Neal Fultz, Colin

Gillespie, Christoph Stepper, Thomas Leeper, Mark van der Loo, Jan Gorecki,

and others.



### License



GPL (>= 2)