codama

Common prOcesses for Data quAlity Monitoring

https://github.com/ob7-ird/codama

Keywords

Repository

Common prOcesses for Data quAlity Monitoring

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
options(tibble.print_min = 5, tibble.print_max = 5)
```

# codama R package 


[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/codama)](https://cran.r-project.org/package=codama)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R-CMD-check](https://github.com/OB7-IRD/codama/workflows/R-CMD-check/badge.svg)](https://github.com/OB7-IRD/codama/actions)


***Common prOcesses for Data quAlity Monitoring***

## Warning
Package and documentation still in construction !

## Overview

This package aims is to provide a series of standardised and generic controls processes for data quality assessment and monitoring.

* Process transparency: the code is fully documented and the [documentation](https://ob7-ird.github.io/codama/) of how works the program will be available.
* Open access and Open source: the code source is hosted on a github repository [codama](https://github.com/OB7-IRD/codama/) under a GPL version 3 license. In the end, it would be available on the Comprehensive R Archive Network (CRAN).
* Referencing of the software : enable result reproducibility and versioning 

## Installation

Working in progress for this section. Be patient.
```{r, eval = FALSE}
devtools::install_github("https://github.com/OB7-IRD/codama",
                         INSTALL_opts=c("--no-multiarch"))
```

### Development version

To get a bug fix or to use a feature from the development version, you can install the development version of furdeb from GitHub.

```{r, eval = FALSE}
devtools::install_github("https://github.com/OB7-IRD/codama",
                         ref = "development",
                         INSTALL_opts=c("--no-multiarch"))
```

## Cheatsheet

Working in progress for this section. Be patient.

## Usage

```{r, message = FALSE}
library(codama)
# Next steps example will be added later
```

## Getting help

If you encounter a clear bug, please file an issue with a minimal reproducible example on [GitHub issues page](https://github.com/OB7-IRD/codama/issues). This link is also available if you have any questions and improvement propositions.

## References

Working in progress for this section.

Owner

Citation (CITATION.cff)

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "codama" in publications use:'
type: software
license: GPL-3.0-only
title: 'codama: Common prOcesses for Data quAlity Monitoring'
version: 1.1.0
abstract: This package aims is to provide a series of standardised and generic controls
  processes for data quality assessment and monitoring.
authors:
- family-names: Bouhineau
  given-names: Oceane
  email: oceane.bouhineau@ird.fr
  orcid: https://orcid.org/0000-0001-7418-2925
- family-names: Depetris
  given-names: Mathieu
  email: mathieu.depetris@ird.fr
  orcid: https://orcid.org/0000-0001-8080-0531
- family-names: Fily
  given-names: Theotime
  email: theotime.fily@ird.fr
  orcid: https://orcid.org/0000-0001-7277-1769
- family-names: Lebranchu
  given-names: Julien
  email: julien.lebranchu@ird.fr
  orcid: https://orcid.org/0000-0002-7759-0534
- family-names: Lerebourg
  given-names: Clara
  email: clara.lerebourg@ird.fr
  orcid: https://orcid.org/0000-0003-0589-8932
- family-names: Mollier
  given-names: Esther
  email: esther.mollier@ird.fr
  orcid: https://orcid.org/0000-0001-8921-079X
repository-code: https://github.com/OB7-IRD/codama
url: https://github.com/OB7-IRD/codama
contact:
- family-names: Bouhineau
  given-names: Oceane
  email: oceane.bouhineau@ird.fr
  orcid: https://orcid.org/0000-0001-7418-2925
keywords:
- pkgdown
- r

GitHub Events