README.Rmd

---
output: github_document
editor_options: 
  chunk_output_type: console
---

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

```{r, echo = FALSE, message = FALSE, error = FALSE, warning = FALSE}
library(tidyverse)
```

<!-- badges: start -->
[![R build status](https://github.com/dynverse/dynguidelines/workflows/R-CMD-check/badge.svg)](https://github.com/dynverse/dynguidelines/actions)
[![codecov](https://codecov.io/gh/dynverse/dynguidelines/branch/master/graph/badge.svg)](https://codecov.io/gh/dynverse/dynguidelines) 
<img src="man/figures/logo.png" align="right" width="150px" />
<!-- badges: end -->

# Selecting the most optimal TI methods

This package summarises the results from the [dynbenchmark](https://www.github.com/dynverse/dynbenchmark) evaluation of trajectory inference methods. Both programmatically and through a (shiny) app, users can select the most optimal set of methods given a set of user and dataset specific parameters.

Installing the app:
```{r eval=FALSE}
# install.packages("devtools")
devtools::install_github("dynverse/dynguidelines")
```

Running the app:
```{r eval=FALSE}
dynguidelines::guidelines_shiny()
```

See [dyno](https://www.github.com/dynverse/dyno) for more information on how to use this package to infer and interpret trajectories.

<!-- This gif was recorded using peek (https://github.com/phw/peek) --->
![demo](man/figures/demo.gif)

## Latest changes
Check out `news(package = "dynguidelines")` or [NEWS.md](NEWS.md) for a full list of changes.

<!-- This section gets automatically generated from NEWS.md -->

```{r news, echo=FALSE, results="asis"}
cat(dynutils::recent_news())
```