https://github.com/poissonconsulting/fishbc

An R package of Fish Codes for British Columbia
https://github.com/poissonconsulting/fishbc

bc cran fish rstats

Last synced: 5 months ago
JSON representation

An R package of Fish Codes for British Columbia

• Host: GitHub
• URL: https://github.com/poissonconsulting/fishbc
• Owner: poissonconsulting
• License: cc-by-4.0
• Created: 2020-05-28T21:53:39.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-26T18:56:41.000Z (5 months ago)
• Last Synced: 2024-11-26T19:35:45.613Z (5 months ago)
• Topics: bc, cran, fish, rstats
• Language: R
• Homepage: https://poissonconsulting.github.io/fishbc/
• Size: 1.23 MB
• Stars: 5
• Watchers: 5
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# fishbc

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![R-CMD-check](https://github.com/poissonconsulting/fishbc/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/fishbc/actions/workflows/R-CMD-check.yaml)

[![codecov](https://codecov.io/gh/poissonconsulting/fishbc/branch/master/graph/badge.svg?token=2EvrLVvDcZ)](https://codecov.io/gh/poissonconsulting/fishbc)

[![License: CCBY4](https://img.shields.io/badge/License-CCBY4-green.svg)](https://creativecommons.org/licenses/by/4.0/)

[![CRAN status](https://www.r-pkg.org/badges/version/fishbc)](https://CRAN.R-project.org/package=fishbc)

![CRAN downloads](https://cranlogs.r-pkg.org/badges/fishbc)

## Introduction

`fishbc` is an R package that provides provides raw and curated data on the codes, classification and conservation status of freshwater fishes in British Columbia. 

Marine fishes will be added in a future release.

It also include raw fish codes for BC Conservation Data Centre and the Government of Alberta.

It contains information licensed under the [Open Government Licence – British Columbia](https://www2.gov.bc.ca/gov/content/data/open-data/open-government-licence-bc) and the [Open Government Licence - Alberta](https://open.alberta.ca/licence)

## Installation

To install the latest release from [CRAN](https://cran.r-project.org)

```r

install.packages("fishbc")

```

To install the latest development version from [GitHub](https://github.com/poissonconsulting/fishbc)

```r

# install.packages("remotes")

remotes::install_github("poissonconsulting/fishbc")

```

## Demonstration

Get the curated freshwater fish of BC fish codes.

```{r}

library(tibble) # for tidy printing

fishbc::freshwaterfish

```

Get the common names for fish codes.

```{r}

fishbc::fbc_common_name(c("AF", "WSG", NA, "AF", "NOTACODE"))

```

## Contribution

Please report any [issues](https://github.com/poissonconsulting/fishbc/issues).

[Pull requests](https://github.com/poissonconsulting/fishbc/pulls) are always welcome.

## Code of Conduct

Please note that the fishbc project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). 

By contributing to this project, you agree to abide by its terms.