README.md

lockr

Overview

lockr is a user-friendly R package designed for encrypting/decrypting files, with the aim of facilitating the storage and sharing of research compendiums using R.

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

Prerequisites

To use the main functions of lockr, some familiarity with the R programming language is required.

If you are not comfortable with R, we strongly recommend checking out Hadley Wickham and Garrett Grolemund’s free online book R for Data Science, as well as the Coursera course Data Science: Foundations using R from John Hopkins University (free for audit students).

Installation

You can install lockr using:

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

Citation

If you use lockr in your research, please consider citing it. We have put a lot of work into building and maintaining this free and open-source R package. The citation can be found below.

citation("lockr")
#> 
#> To cite {lockr} in publications use:
#> 
#>   Vartanian, D. (2023). {lockr}: easily encrypt/decrypt files. R
#>   package version 0.3.0.9000. https://giperbio.github.io/lockr/
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Unpublished{,
#>     title = {{lockr}: easily encrypt/decrypt files},
#>     author = {Daniel Vartanian},
#>     year = {2023},
#>     url = {https://giperbio.github.io/lockr/},
#>     note = {R package version 0.3.0.9000},
#>   }

Contributing

We welcome contributions, including bug reports.

Please take a moment to review our Guidelines for Contributing.

Become a supporter of lockr!

Click here to make a donation. Please indicate the lockr package in your donation message.