README.Rmd

---
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-"
)
# Please put your title here to include it in the file below.
Title <- "`hubEnsembles`: Ensembling Methods in R"
```

# hubEnsemblesManuscript

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/hubverse-org/hubEnsemblesManuscript/master?urlpath=rstudio)


This repository contains the data and code for our paper:

> Li Shandross, Emily Howerton, Lucie Contamin, Harry Hochheiser, Anna Krystalli, Consortium of Infectious Disease Modeling Hubs, Nicholas G. Reich, Evan L. Ray (in prep). *`hubEnsembles`: Ensembling Methods in R*. 


### How to cite

Please cite this compendium as:

> Li Shandross, Emily Howerton, Lucie Contamin, Harry Hochheiser, Anna Krystalli, Consortium of Infectious Disease Modeling Hubs, Nicholas G. Reich, Evan L. Ray (in prep). *Compendium of R code and data for `hubEnsembles`:
> Ensembling Methods in R*. Accessed 12 Apr 2024. Online at
> <https://doi.org/10.1101/2024.06.24.24309416>

## Contents

The **analysis** directory contains:

  - [:file\_folder: paper](/analysis/paper): Quarto source document
    for manuscript. Includes code to reproduce the figures and tables
    generated by the analysis. It also has a rendered version,
    `hubEnsembles_manuscript.html`, suitable for reading (the code is replaced by figures
    and tables in this file)
  - [:file\_folder: data](/analysis/data): Data used in the analysis.
  - [:file\_folder: figures](/analysis/figures): Plots and other
    illustrations


## How to run in your browser or download and run locally

This research compendium has been developed using the statistical programming
language R. To work with the compendium, you will need
installed on your computer the [R software](https://cloud.r-project.org/)
itself and optionally [RStudio Desktop](https://rstudio.com/products/rstudio/download/).

You can download the compendium as a zip from from this URL:
[master.zip](/archive/master.zip). After unzipping:

- open the `.Rproj` file in RStudio
- run `devtools::install(dependencies = TRUE)` to ensure you have the packages this analysis depends on (also listed in the
[DESCRIPTION](/DESCRIPTION) file). You might need to install `devtools` first by running `install.packages("devtools")`.
- finally, open `analysis/paper/hubEnsembles_manuscript.qmd` and knit to produce the `hubEnsembles_manuscript.html`, or run `rmarkdown::render("analysis/paper/hubEnsembles_manuscript.qmd")` in the R console

### Licenses

**Text and figures :**  [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/)

**Code :** See the [DESCRIPTION](DESCRIPTION) file

**Data :** [CC-0](http://creativecommons.org/publicdomain/zero/1.0/) attribution requested in reuse