Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshwlambert/lifecycling
Guide to versioning and badging R packages
https://github.com/joshwlambert/lifecycling
lifecycle r r-package versioning
Last synced: about 2 months ago
JSON representation
Guide to versioning and badging R packages
- Host: GitHub
- URL: https://github.com/joshwlambert/lifecycling
- Owner: joshwlambert
- License: other
- Created: 2023-04-13T10:04:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-21T17:31:10.000Z (over 1 year ago)
- Last Synced: 2024-06-04T23:04:20.040Z (4 months ago)
- Topics: lifecycle, r, r-package, versioning
- Language: R
- Homepage: https://joshwlambert.github.io/lifecycling/
- Size: 464 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - joshwlambert/lifecycling - Guide to versioning and badging R packages (R)
README
---
output: github_document
---```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```# lifecycling :bicyclist: :bicyclist: :bicyclist:
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![R-CMD-check](https://github.com/joshwlambert/lifecycling/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/joshwlambert/lifecycling/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/joshwlambert/lifecycling/branch/main/graph/badge.svg)](https://app.codecov.io/gh/joshwlambert/lifecycling?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/joshwlambert/lifecycling?color=%23E6E6FA)
![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/joshwlambert/lifecycling/v0.1.0/main)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](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("joshwlambert/lifecycling")
```## Lifecycles
The three types of lifecycle badges explored in this repo are:
- tidyverse {lifecycle}
- reconverse lifecycles
- repostatusThe lifecycle badges available from each of these are:
### {lifecycle}
``` r
- lifecycle::badge("experimental")
``````{r, results="asis", echo=FALSE}
cat("![](man/figures/lifecycle-experimental.svg)\n")
`````` r
- lifecycle::badge("stable")
``````{r, results="asis", echo=FALSE}
cat("![](man/figures/lifecycle-stable.svg)\n")
`````` r
- lifecycle::badge("superseded")
``````{r, results="asis", echo=FALSE}
cat("![](man/figures/lifecycle-superseded.svg)\n")
`````` r
- lifecycle::badge("deprecated")
``````{r, results="asis", echo=FALSE}
cat("![](man/figures/lifecycle-deprecated.svg)\n")
```### reconverse
```{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-concept.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-experimental.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-maturing.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-stable.svg)\n")
```### RepoStatus
```{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/concept.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/wip.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/suspended.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/abandoned.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/active.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/inactive.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/unsupported.svg)\n")
``````{r, results="asis", echo=FALSE}
cat("![](https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/moved.svg)\n")
```## Example
This is a basic example which shows you how to solve a common problem:
```{r example, error=TRUE}
library(lifecycling)# basic demonstration of functions from {lifecycle}:
expe_func()
dep_func()
soft_dep_func()
hard_dep_func()
sup_func()
```