joshwlambert / lifecycling

Guide to versioning and badging R packages

lifecycling 🚴 🚴 🚴

The goal of lifecycling is to demonstrate good practises for communicating the development of code through versioning and lifecycle stages.

Installation

You can install the development version of lifecycling from GitHub with:

# install.packages("devtools")
devtools::install_github("joshwlambert/lifecycling")

Lifecycles

The three types of lifecycle badges explored in this repo are:

• tidyverse {lifecycle}
• reconverse lifecycles
• repostatus

The lifecycle badges available from each of these are:

{lifecycle}

- lifecycle::badge("experimental")

- lifecycle::badge("stable")

- lifecycle::badge("superseded")

- lifecycle::badge("deprecated")

reconverse

RepoStatus

Example

This is a basic example which shows you how to solve a common problem:

library(lifecycling)

# basic demonstration of functions from {lifecycle}:

expe_func()
#> [1] "lifecycles"
dep_func()
#> Warning: `dep_func()` was deprecated in lifecycling 0.1.0.
#> This warning is displayed once every 8 hours.
#> Call `lifecycle::last_lifecycle_warnings()` to see where this warning was
#> generated.
#> [1] "Deprecated function"
soft_dep_func()
#> Warning: `soft_dep_func()` was deprecated in lifecycling 0.1.0.
#> This warning is displayed once every 8 hours.
#> Call `lifecycle::last_lifecycle_warnings()` to see where this warning was
#> generated.
#> [1] "Deprecated function"
hard_dep_func()
#> Error:
#> ! `hard_dep_func()` was deprecated in lifecycling 0.1.0 and is now
#>   defunct.
sup_func()
#> [1] "lifecycles"