https://github.com/ecohealthalliance/ohcleandat

One Health Data Cleaning and Quality Checking Package
https://github.com/ecohealthalliance/ohcleandat

Last synced: about 1 month ago
JSON representation

One Health Data Cleaning and Quality Checking Package

• Host: GitHub
• URL: https://github.com/ecohealthalliance/ohcleandat
• Owner: ecohealthalliance
• License: mit
• Created: 2024-04-11T02:52:20.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-23T00:11:10.000Z (about 2 months ago)
• Last Synced: 2024-11-02T16:08:09.695Z (about 1 month ago)
• Language: R
• Homepage: https://ecohealthalliance.github.io/ohcleandat/
• Size: 1.92 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - ecohealthalliance/ohcleandat - One Health Data Cleaning and Quality Checking Package (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# ohcleandat

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

This package provides useful functions to orchestrate analytics and data cleaning pipelines for One Health projects.  

## Installation

You can install the development version of ohcleandat from [GitHub](https://github.com/ecohealthalliance/ohcleandat) with:

``` r

# install.packages("devtools")

devtools::install_github("ecohealthalliance/ohcleandat")

```

 

## Getting Started   

For help guides, check out the package vignettes.   

## Contributions  

This project uses the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). 

All new feature requests should be done in a new branch based on `dev` or a fork of `dev`. New branches can take the form `feature/*` or `fix/*`. Once the feature is complete, automated CI checks and merge checks will be performed and a pull request should be raised to merge changes into `dev`.  

Once the package is nearing a release, a `release/x.x.x` branch should be created from the head of `dev`. This is used to make any changes to convert the code to production level and to increment the version number and make release notes if required before raising a PR into `main`. Once the PR into `main` is accepted, a github release should be performed, using the package version

as the tag. 

A final step is deleting any feature and release branches and merging `main` back into `dev` and

incrementing the `dev` version to `x.x.x.9000`. 

## Getting Help  

If you encounter a clear bug, please file a minimal reproducible example on [github](https://github.com/ecohealthalliance/ohcleandat/issues).