README.md

rc.sqlr

Project Status: WIP – Initial development is in progress, but there
has not yet been a stable, usable release suitable for the
public. Lifecycle:
experimental R-CMD-check Codecov test
coverage License:
MIT License: CC BY
4.0

This is a template repository for systematic quantitative literature reviews (SQLR) research compendiums.

Overview

rc.sqlr is an R package with the research compendium of the Interdisciplinary Research Group on Biological Rhythms (GIPERBIO) [INSERT NAME OF THE PROJECT] systematic quantitative literature review 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).

Learn more about systematic quantitative literature reviews here.

Installation

You can install rc.sqlr with:

# install.packages("remotes")
remotes::install_github("giperbio/rc.sqlr")

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

License

License:
MIT License: CC BY
4.0

rc.sqlr code is released under the MIT license and its data under the CC BY 4.0 license.

Citation

If you use rc.sqlr 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.

citation("rc.sqlr")
#> 
#> To cite {rc.sqlr} in publications use:
#> 
#>   Vartanian, D. (2023). {rc.sqlr}: research compendium of the GIPERBIO
#>   [INSERT NAME OF THE PROJECT] systematic quantitative literature
#>   review project. R package version 0.0.0.9000.
#>   https://giperbio.github.io/rc.sqlr/
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Unpublished{,
#>     title = {{rc.sqlr}: research compendium of the GIPERBIO [INSERT NAME OF THE PROJECT] systematic quantitative literature review project},
#>     author = {Daniel Vartanian},
#>     year = {2023},
#>     url = {https://giperbio.github.io/rc.sqlr/},
#>     note = {R package version 0.0.0.9000},
#>   }


gipso/sqlr.template documentation built on March 11, 2023, 5:36 a.m.