---
output: github_document
---

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

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README_files/"
)
options(width = 100)
```

# INTEREST <img src="man/figures/hex.png" width = "150" align="right" />

INTEREST, acronym for **IN**teractive **T**ool for **E**xploring **RE**sults from **S**imulation s**T**udies, is an interactive web app developed using R and [`shiny`](https://shiny.rstudio.com/). It allows exploring results from simulation studies interactively.

<!-- badges: start -->
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/ellessenne/interest?branch=master&svg=true)](https://ci.appveyor.com/project/ellessenne/interest)
[![Travis-CI Build Status](https://travis-ci.org/ellessenne/interest.svg?branch=master)](https://travis-ci.org/ellessenne/interest)
<!-- badges: end -->

# Live demo

A live demo of INTEREST can be found [here](https://interest.shinyapps.io/interest/). Please note that this version is still under active development: bug reports and feature requests are welcome.

# Installation

INTEREST can be installed locally as a standalone R package, by typing the following R commands in your R console:

```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("ellessenne/interest")
```

This requires a working installation of [R](https://www.r-project.org/) and, preferably, [RStudio](https://www.rstudio.com/).

# Launch application

To launch INTEREST first load the `interest` R package:

```{r load, eval = FALSE}
library(interest)
```

Then, use the `interest()` function:

```{r launch, eval = FALSE}
interest()
```

The app should now launch in your browser.

# Workflow

![](README_files/sirex-workflow.png)

The workflow of INTERACT is simple: 

1. Load your data and define variables representing point estimates, standard errors, methods, and so on;
1. Performance measures are estimated automatically;
1. Tables and plots are produced automatically, and can be customised and explored interactively;
1. Tables and plots can be exported for later use.

# Additional material on INTEREST

* Slides on [`rsimsum`](https://ellessenne.github.io/rsimsum/) and INTEREST presented at the 2019 useR! conference [[here]](https://github.com/ellessenne/rsimsum/blob/master/inst/Talks/ag-useR-2019.pdf)

* Slides to present SiReX (former name of INTEREST) at the Students’ Day, 38^th^ Annual Conference of the International Society for Clinical Biostatistics [[here]](README_files/iscb38_slides.pdf)

* Poster at the 2017 Annual Conference of the Department of Health Sciences, University of Leicester [[here]](README_files/hs_poster.pdf)
