README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

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

# bistro: bloodmeal identification by STR overlap <a href='https://github.com/duke-malaria-collaboratory/bistro'><img src='man/figures/logo.png' align="right" height="120" /></a>

<!-- badges: start -->
[![R-CMD-check](https://github.com/duke-malaria-collaboratory/bistro/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/duke-malaria-collaboratory/bistro/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/duke-malaria-collaboratory/bistro/branch/main/graph/badge.svg)](https://app.codecov.io/gh/duke-malaria-collaboratory/bistro?branch=main)
[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
[![DOI](https://zenodo.org/badge/687221823.svg)](https://zenodo.org/badge/latestdoi/687221823)


<!-- badges: end -->

Functions to allow for the identification of matches between bloodmeals and the people they bit using short tandem repeat (STR) profiles of human blood from freshly fed bloodmeals and from people.

## Installation

You can install bistro like so:

``` r
# install.packages("remotes")
remotes::install_github("duke-malaria-collaboratory/bistro")
```

## Dependencies:

```{r deps, echo = FALSE, message = FALSE, warning = FALSE}
library(dplyr)
description <- utils::packageDescription("bistro",
  fields = c("Depends", "Imports", "Suggests")
)
deps <- lapply(
  names(description),
  function(x) {
    paste0(
      "- ", x, ": ",
      description[[x]] %>%
        gsub("\n", " ", .)
    )
  }
) %>%
  unlist() %>%
  paste(., collapse = "\n")
```

`r deps`

## Usage

Check out the [vignette](https://duke-malaria-collaboratory.github.io/bistro/articles/bistro.html) for more information. 

## Have questions or need help troubleshooting?

Open up an [issue](https://github.com/duke-malaria-collaboratory/bistro/issues) on our GitHub page or contact us (Christine: christine.markwalter@duke.edu, Zena: zenalapp@gmail.com) and we can help out.