In gipso/r.template: Template for Research Compendiums

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

library(rc.template)

rc.template

This is a template repository for research compendiums.

Overview

rc.template is an R package with the research compendium of the Interdisciplinary Research Group on Biological Rhythms (GIPERBIO) [INSERT NAME OF THE PROJECT] project. Its aim is to facilitate the research work and to improve reproducibility in research.

The assemble of this package was inspired by Ben Marwick, Carl Boettiger & Lincoln Mullen's article Packaging Data Analytical Work Reproducibly Using R (and Friends).

Installation

You can install rc.template with:

``` {r, eval = FALSE}

install.packages("remotes")

remotes::install_github("giperbio/rc.template")

We don’t intend to publish this package on CRAN.

## Encryption

Some data files were encrypted in order to preserve the anonymity of the study participants. You can identify those files by the `.encryptr.bin` extension. Contact the authors if you need access to them.

## License

[![License:
MIT](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/license/mit/)

`rc.template` code is released under the [MIT license](https://opensource.org/license/mit/). Please note that `rc.template` data are proprietary and cannot be shared without the authors' permission.

## Citation

If you use `rc.template` in your research, please consider citing it. We put a lot of work to build and maintain a free and open-source R package. You can find the citation below.

```r
citation("rc.template")