Skip to content

Commit

Permalink
splitting packages into their own tab, bring archive
Browse files Browse the repository at this point in the history
  • Loading branch information
dsweber2 committed May 1, 2024
1 parent 083cc57 commit b7c3883
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 97 deletions.
97 changes: 59 additions & 38 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -117,44 +117,12 @@ relativeURLs = false
name = "Tools Overview"
url = "/tools/"
weight = 1
[[menu.main]]
parent = "tools"
name = "Delphi Tooling Book"
url = "https://cmu-delphi.github.io/delphi-tooling-book/"
weight = 5
# packages
[[menu.main]]
parent = "tools"
identifier = "Packages"
name = "Packages"
url = "https://delphi.cmu.edu/tools/"
weight = 6
[[menu.main]]
parent = "Packages"
name = "Epidatr"
url = "https://cmu-delphi.github.io/epidatr/"
weight = 7
[[menu.main]]
parent = "Packages"
name = "Epidatpy"
url = "https://github.com/cmu-delphi/epidatpy"
weight = 20
[[menu.main]]
parent = "Packages"
name = "Epiprocess"
url = "https://cmu-delphi.github.io/epiprocess/"
weight = 7
[[menu.main]]
parent = "Packages"
name = "Epipredict"
url = "https://cmu-delphi.github.io/epipredict/"
weight = 7
# utils
[[menu.main]]
parent = "tools"
identifier = "utils"
name = "Dashboards"
url = "https://delphi.cmu.edu/tools/"
url = "tools#Dashboards"
weight = 9
[[menu.main]]
parent = "utils"
Expand Down Expand Up @@ -184,14 +152,14 @@ relativeURLs = false
[[menu.main]]
parent = "tools"
name = "Archived Tools"
url = "/tools/archive/"
url = "tools#archive"
weight = 80

[[menu.main]]
parent = "tools"
identifier = "forecasting"
name = "Forecasting"
url = "https://www.cdc.gov/flu/weekly/flusight/index.html"
url = "tools#forecasting"
weight = 50

[[menu.main]]
Expand All @@ -206,11 +174,64 @@ relativeURLs = false
weight = 2

[[menu.main]]
identier = "github"
identier = "Packages"
pre = "solid/code"
name = "Packages"
url = "packages"
weight = 90
[[menu.main]]
parent = "Packages"
name = "Packages overview"
url = "packages"
weight = 1
[[menu.main]]
parent = "Packages"
identifier = "APIClients"
name = "API and clients"
url = "packages#API_and_its_clients"
weight = 2
[[menu.main]]
parent = "APIClients"
name = "Epidata"
url = "https://github.com/cmu-delphi/delphi-epidata"
weight = 7
[[menu.main]]
parent = "APIClients"
name = "Epidatr"
url = "https://cmu-delphi.github.io/epidatr/"
weight = 8
[[menu.main]]
parent = "APIClients"
name = "Epidatpy"
url = "https://github.com/cmu-delphi/epidatpy"
weight = 9

[[menu.main]]
parent = "Packages"
identifier = "forecastingCode"
name = "Forecasting"
url = "packages#Forecasting"
weight = 10
[[menu.main]]
parent = "forecastingCode"
name = "Forecasting Manual"
weight = 1
[[menu.main]]
parent = "forecastingCode"
name = "Epiprocess"
url = "https://cmu-delphi.github.io/epiprocess/"
weight = 7
[[menu.main]]
parent = "forecastingCode"
name = "Epipredict"
url = "https://cmu-delphi.github.io/epipredict/"
weight = 7
[[menu.main]]
parent = "Packages"
name = "Github"
pre = "brands/github"
name = "GitHub"
url = "https://github.com/cmu-delphi/"
weight = 90
weight = 70


[[menu.main]]
Expand Down
47 changes: 47 additions & 0 deletions content/packages/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Packages
linkTitle: packages
layout: single
---
In addition to our API server code, we have a number of user oriented packages, such as API clients and time-series modeling for epidemiology. All source code is freely available on [GitHub](https://github.com/cmu-delphi/).
## API and its clients
### [Epidata](https://github.com/cmu-delphi/delphi-epidata)
The core server code for our [API](https://cmu-delphi.github.io/delphi-epidata/).
### [Epidatr](https://cmu-delphi.github.io/epidatr/)

R client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
It allows you to cache queries locally to speed up data access and seamlessly integrate pulling from our API into your pipelines.

### [Epidatpy](https://github.com/cmu-delphi/epidatpy) (WIP)

A work-in-progress Python client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
Not yet recommended for production, but we are happy to receive feedback!


## Forecasting
### [Introduction to Epidemiological Forecasting: Delphi Tools, Data, and Lessons](https://cmu-delphi.github.io/delphi-tooling-book/)

An introduction to epidemiological forecasting using our tools: epiprocess and epipredict.

### [Epiprocess](https://cmu-delphi.github.io/epiprocess/)

A collection of data structures and methods for handling epidemiological data.
The major features are:
- The epi_df structure, which allows you track epidemiological data measured over location and time (and other potential keys).
- The epi_archive structure, which allows you to store epi_df objects in a versioned archive and to query the archive for the state of the data at any point in time.
- Support for applying generic functions across a sliding time window, building on tools like [slider](https://slider.r-lib.org/). Comes with support for
- handling gaps in time
- automatically handling grouping of keys
- Support for version aware data transformation and forecasting, which allows for simple and accurate backtesting of forecasting models (using only the actual data that was available at the time of the forecast and not the revised versions).
- Growth rate estimation, as estimated using relative rates of change, linear regression, smooth splines, or polynomial trend filtering.
- Outlier detection and correction, using rolling median or LOESS trend decomposition.
- Signal correlation over space, time and other keys. It also supports lagged correlations, automatically handles grouping by the specified keys, and handles time gaps.

### [Epipredict](https://cmu-delphi.github.io/epipredict/)

A framework for building epidata pipelines involving transformation and forecasting. It is designed to work smoothly with epiprocess and provides a simple interface for defining and running forecasting workflows. It supports:
- A simple interface for defining a sequence of data pre-processing, forecasting, and post-processing steps.
- A collection of data processing steps common to epidata.
- A collection of pre-packaged forecasting models commonly used by Delphi's forecasting team.

## Deprecated Packages
81 changes: 61 additions & 20 deletions content/tools/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,35 @@ title: Tools Overview
linkTitle: Tools
layout: single
---
## [Delphi Epidata API](https://github.com/cmu-delphi/delphi-epidata)

API for getting up-to-date epidemiological data (also available via a web interface through [EpiVis](https://delphi.cmu.edu/epivis/epivis.html) and a [Dashboard](covidcast/dashboard)).

## Dashboards

### [Delphi Epidata Dashboard](covidcast/dashboard)
The primary dashboard to interact with delphi data. If you wish to access the results programmatically, see the [API](#Delphi_Epidata_API), or one of it's clients.
### [Indicator Status](https://delphi.cmu.edu/covidcast/indicator-status/)

A dashboard for displaying the lags for various signals in the Delphi Epidata API.

### [Dashboard Builder](https://delphi.cmu.edu/covidcast/dashboard)

A builder that allows you to customize the [Delphi Epidata Dashboard](/covidcast/).

### [EpiVis](https://delphi.cmu.edu/epivis/)

Epidemiological time series visualizer.



## Forecasting
### [COVID-19 Forecasting Evaluation](https://delphi.cmu.edu/forecast-eval/)

We host a forecast evaluation dashboard to compare the historical performance of the forecasts submitted to the [COVID-19 Forecast Hub](https://covid19forecasthub.org/).




### [Flu Forecasting (FluSight)](https://www.cdc.gov/flu/weekly/flusight/index.html)

Expand All @@ -18,10 +45,41 @@ We participate in weekly COVID hospital admissions forecasting at the state and
Our current system for generating forecasts will be available soon [here](https://github.com/cmu-delphi/covid-hosp-forecast).
In addition to publishing the individual forecasts from the participating groups, the Reich lab makes an ensemble prediction, and hosts a [visualization of both](https://viz.covid19forecasthub.org).

### [COVID-19 Forecasting Evaluation](https://delphi.cmu.edu/forecast-eval/)

We host a forecast evaluation dashboard to compare the historical performance of the forecasts submitted to the [COVID-19 Forecast Hub](https://covid19forecasthub.org/).
## Archived
### [COVIDcast 1.0 ("Classic")](/covidcast/classic)

A map-first single-page webapp for visualizing COVID-19 pandemic indicators.

### [Crowdcast](/crowdcast)

Delphi’s "Wisdom of crowds" forecasting system: Used for Chikungunya, flu and most recently Covid. In it's archived configuration, this system was set up to forecast ILI during the COVID-19 pandemic

### [ILI Nearby](/nowcast)

Flu nowcasting system.

**Note:** This system is designed to nowcast ILI driven by seasonal
influenza and is NOT designed to nowcast ILI during the COVID-19 pandemic.

### [Epiforecast](https://github.com/cmu-delphi/epiforecast-R)

R package that implements several methods for epidemiological forecasting empirical bayes (EB), basis regression (BR), and time-weighted kernel density estimation (twkde).

### [Nowcast](https://github.com/cmu-delphi/nowcast)

A sensor fusion based nowcasting system developed to predict ILI before the COVID-19 pandemic

### [Fluscores](https://delphi.cmu.edu/misc/fluscores/)

Visual comparison of scored submissions to CDC Flu Forecasting Challenge for 2014-16 (provide your own score files).

### [utils](https://github.com/cmu-delphi/utils)

Old python utility package, mainly for handling dates and locations.

# Notes
separate out packages into a separate tab
## Packages

All source code is freely available on [GitHub](https://github.com/cmu-delphi/).
Expand All @@ -31,7 +89,7 @@ All source code is freely available on [GitHub](https://github.com/cmu-delphi/).
R client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
It allows you to cache queries locally to speed up data access and seamlessly integrate pulling from our API into your pipelines.

### [Delphi Tooling Book](https://cmu-delphi.github.io/delphi-tooling-book/)
### [Epidemiological Forecasting with Delphi Tooling Packages](https://cmu-delphi.github.io/delphi-tooling-book/)

An introduction to epidemiological forecasting using our tools: epiprocess and epipredict.

Expand Down Expand Up @@ -61,20 +119,3 @@ A framework for building epidata pipelines involving transformation and forecast
A work-in-progress Python client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
Not yet recommended for production, but we are happy to receive feedback!

## Operational Systems

### [Delphi Epidata API](https://github.com/cmu-delphi/delphi-epidata)

API for getting up-to-date epidemiological data (also available via a web interface through [EpiVis](https://delphi.cmu.edu/epivis/epivis.html)).

### [Indicator Status](https://delphi.cmu.edu/covidcast/indicator-status/)

A dashboard for displaying the lags for various signals in the Delphi Epidata API.

### [Dashboard Builder](https://delphi.cmu.edu/covidcast/dashboard)

A builder that allows you to customize the [Delphi Epidata Dashboard](/covidcast/).

### [EpiVis](https://delphi.cmu.edu/epivis/)

Epidemiological time series visualizer.
39 changes: 0 additions & 39 deletions content/tools/archive.md

This file was deleted.

5 changes: 5 additions & 0 deletions themes/delphi/layouts/shortcodes/packages.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{ $tools := .Site.GetPage "/tools/tools" }}
{{ range sort ($tools.Resources.ByType "page") "Params.order" }}
<h3><a href="{{ .Params.link }}">{{ .Title }}</a></h3>
{{ .Content }}
{{ end }}

0 comments on commit b7c3883

Please sign in to comment.