Skip to content

Commit

Permalink
Add minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
danielvartan committed Nov 4, 2021
1 parent e51b609 commit 356fb1b
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 25 deletions.
2 changes: 1 addition & 1 deletion R/encrypt.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' @description
#'
#' `r lifecycle::badge("experimental")`
#' `r lifecycle::badge("maturing")`
#'
#' `encrypt_extdata()` and `decrypt_extdata()` encrypt/decrypt files from
#' the `extdata` folder of an R package.
Expand Down
2 changes: 1 addition & 1 deletion R/get_key.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' @description
#'
#' `r lifecycle::badge("experimental")`
#' `r lifecycle::badge("maturing")`
#'
#' `get_private_key()` and `get_public_key()` returns the data of a
#' private/public key inside an R package.
Expand Down
9 changes: 4 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ library(encryptrpak)
# encryptrpak <a href='https://gipso.github.io/encryptrpak/'><img src='man/figures/logo.png' align="right" height="139" /></a>

<!-- badges: start -->
![CRAN status](https://www.r-pkg.org/badges/version/encryptrpak)
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[![R-CMD-check](https://github.com/gipso/encryptrpak/workflows/R-CMD-check/badge.svg)](https://github.com/gipso/encryptrpak/actions)
[![Codecov test coverage](https://codecov.io/gh/gipso/encryptrpak/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gipso/encryptrpak?branch=main)
[![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://choosealicense.com/licenses/mit/)
Expand All @@ -36,15 +35,15 @@ Please note that `encryptrpak` is not related in any way with the `encryptr` dev

## Installation

`encryptrpak` will always be at the [experimental](https://lifecycle.r-lib.org/articles/stages.html#experimental) stage of development. We don't intend to publish this package to CRAN.

You can install `encryptrpak` from GitHub with:

``` {r, eval = FALSE}
# install.packages("remotes")
remotes::install_github("gipso/encryptrpak")
```

We don't intend to publish this package to CRAN.

## Citation

If you use `encryptrpak` 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 `encryptrpak` citation below.
Expand Down
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@

<!-- badges: start -->

![CRAN status](https://www.r-pkg.org/badges/version/encryptrpak)
[![Project Status: WIP – Initial development is in progress, but there
has not yet been a stable, usable release suitable for the
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[![R-CMD-check](https://github.com/gipso/encryptrpak/workflows/R-CMD-check/badge.svg)](https://github.com/gipso/encryptrpak/actions)
[![Codecov test
coverage](https://codecov.io/gh/gipso/encryptrpak/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gipso/encryptrpak?branch=main)
Expand All @@ -33,17 +32,15 @@ Please note that `encryptrpak` is not related in any way with the

## Installation

`encryptrpak` will always be at the
[experimental](https://lifecycle.r-lib.org/articles/stages.html#experimental)
stage of development. We don’t intend to publish this package to CRAN.

You can install `encryptrpak` from GitHub with:

``` r
# install.packages("remotes")
remotes::install_github("gipso/encryptrpak")
```

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

## Citation

If you use `encryptrpak` in your research, please consider citing it. We
Expand All @@ -55,9 +52,9 @@ citation("encryptrpak")
#>
#> To cite {encryptrpak} in publications use:
#>
#> Vartanian, D., Pedrazzoli, M. (2021). {encryptrpak}: an R Package to
#> encrypt/decrypt files of R packages.
#> https://gipso.github.io/encryptrpak/.
#> Vartanian, D., & Pedrazzoli, M. (2021). {encryptrpak}: an R Package
#> to encrypt/decrypt files of R packages.
#> https://gipso.github.io/encryptrpak/
#>
#> A BibTeX entry for LaTeX users is
#>
Expand All @@ -66,7 +63,7 @@ citation("encryptrpak")
#> author = {Daniel Vartanian and Mario Pedrazzoli},
#> year = {2021},
#> url = {https://gipso.github.io/encryptrpak/},
#> note = {Lifecycle: experimental},
#> note = {Lifecycle: maturing},
#> }
```

Expand Down
6 changes: 3 additions & 3 deletions inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ citEntry(
year = "2021",
url = paste0("https://gipso.github.io/",
"encryptrpak/"),
textVersion = paste0("Vartanian, D.", ", ",
textVersion = paste0("Vartanian, D.", ", & ",
"Pedrazzoli, M.", " ",
"(2021)", ". ",
"{encryptrpak}:", " ",
"an R Package to encrypt/decrypt files of R", " ",
"packages", ". ",
"https://gipso.github.io/",
"encryptrpak/", "."),
note = "Lifecycle: experimental"
"encryptrpak/"),
note = "Lifecycle: maturing"
)
2 changes: 1 addition & 1 deletion man/encrypt_extdata.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_private_key.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 356fb1b

Please sign in to comment.