# GitHub Badges

A selection of repository badges that can be added to a [README](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) ([Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) syntax) to help visitors understand the project.
Note that this selection focuses on projects related to data science with [**`R`**](https://cran.r-project.org/).

**N.B.** These badges have been created with [**shields.io**](https://shields.io/badges)

<br/>

> [!TIP]
> To use these badges, copy the **Markdown expression** from the [Raw README](https://raw.githubusercontent.com/FRBCesab/github-badges/refs/heads/main/README.md).


<br/>

### Repository type badges

| Badge | Description |
|:------|:------------|
| ![Research compendium](https://img.shields.io/static/v1?message=Compendium&logo=r&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20) | The project is a [Research compendium](https://cran.r-project.org/web/packages/rcompendium/vignettes/working_with_a_compendium.html) |
| ![Package](https://img.shields.io/static/v1?message=Package&logo=r&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20) | The project is a [R package](https://r-pkgs.org/) |
| ![Quarto presentation](https://img.shields.io/static/v1?message=Presentation&logo=quarto&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20) | The project is a [Quarto presentation](https://quarto.org/docs/presentations/) |
| ![Quarto website](https://img.shields.io/static/v1?message=Website&logo=quarto&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20) | The project is a [Quarto Website](https://quarto.org/docs/websites/) |
| ![Quarto blog](https://img.shields.io/static/v1?message=Blog&logo=quarto&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20) | The project is a [Quarto Blog](https://quarto.org/docs/websites/website-blog.html) |
| ![Quarto book](https://img.shields.io/static/v1?message=Book&logo=quarto&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20) | The project is a [Quarto Book](https://quarto.org/docs/books/) |


<br/>

### Lifecycle badges

| Badge | Description |
|:------|:------------|
| ![Lifecycle Experimental](https://img.shields.io/badge/Lifecycle-Experimental-339999) | The project is in a very early stage of development |
| ![Lifecycle Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6) | The project is under active development |
| ![Lifecycle Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00) | The project is in a reliable state |
| ![Lifecycle Dormant](https://img.shields.io/badge/Lifecycle-Dormant-ff7f2a) | The project is currently not under active development, but there are plans to redevelop |
| ![Lifecycle Retired](https://img.shields.io/badge/Lifecycle-Retired-d45500) | The project is no longer being used and/or supported |


> **_Source:_** <https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md>


<br/>

### License badges

| Badge | Description |
|:------|:------------|
| [![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | MIT License |
| [![License GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) | GNU General Public License, version 2 |
| [![License GPL v3](https://img.shields.io/badge/License-GPL_v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) | GNU General Public License, version 3 |
| [![License Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | Apache License, version 2 |
| [![License CC0 1.0](https://img.shields.io/badge/License-CC0_1.0-green.svg)](https://creativecommons.org/publicdomain/zero/1.0/) | Creative Commons Public Domain Dedication |
| [![License CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-green.svg)](https://creativecommons.org/licenses/by/4.0/) | Creative Commons Attribution 4.0 International |
| [![License CC BY-SA 4.0](https://img.shields.io/badge/License-CC_BY--SA_4.0-green.svg)](https://creativecommons.org/licenses/by-sa/4.0/) | Creative Commons Attribution - Share Alike 4.0 International |
| [![License CC BY-NC 4.0](https://img.shields.io/badge/License-CC_BY--NC_4.0-green.svg)](https://creativecommons.org/licenses/by-nc/4.0/) | Creative Commons Attribution - Non Commercial 4.0 International  |
| [![License CC BY-ND 4.0](https://img.shields.io/badge/License-CC_BY--ND_4.0-green.svg)](https://creativecommons.org/licenses/by-nd/4.0/) | Creative Commons Attribution - No Derivatives 4.0 International |
| [![License CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC_BY--NC--SA_4.0-green.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)| Creative Commons Attribution - Non Commercial - Share Alike 4.0 International |
| [![License CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-green.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/) | Creative Commons Attribution - Non Commercial - No Derivatives 4.0 International |
| [![License ODbL](https://img.shields.io/badge/License-ODbL-brightgreen.svg)](https://opendatacommons.org/licenses/odbl/) | Open Database License |
| [![License Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](http://unlicense.org/) | The Unlicense |