Skip to content

Commit b7c3883

Browse files
dsweber2dsweber2
committed
splitting packages into their own tab, bring archive
1 parent 083cc57 commit b7c3883

File tree

5 files changed

+172
-97
lines changed

5 files changed

+172
-97
lines changed

‎config.toml‎

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -117,44 +117,12 @@ relativeURLs = false
117117
name = "Tools Overview"
118118
url = "/tools/"
119119
weight = 1
120-
[[menu.main]]
121-
parent = "tools"
122-
name = "Delphi Tooling Book"
123-
url = "https://cmu-delphi.github.io/delphi-tooling-book/"
124-
weight = 5
125-
# packages
126-
[[menu.main]]
127-
parent = "tools"
128-
identifier = "Packages"
129-
name = "Packages"
130-
url = "https://delphi.cmu.edu/tools/"
131-
weight = 6
132-
[[menu.main]]
133-
parent = "Packages"
134-
name = "Epidatr"
135-
url = "https://cmu-delphi.github.io/epidatr/"
136-
weight = 7
137-
[[menu.main]]
138-
parent = "Packages"
139-
name = "Epidatpy"
140-
url = "https://github.com/cmu-delphi/epidatpy"
141-
weight = 20
142-
[[menu.main]]
143-
parent = "Packages"
144-
name = "Epiprocess"
145-
url = "https://cmu-delphi.github.io/epiprocess/"
146-
weight = 7
147-
[[menu.main]]
148-
parent = "Packages"
149-
name = "Epipredict"
150-
url = "https://cmu-delphi.github.io/epipredict/"
151-
weight = 7
152120
# utils
153121
[[menu.main]]
154122
parent = "tools"
155123
identifier = "utils"
156124
name = "Dashboards"
157-
url = "https://delphi.cmu.edu/tools/"
125+
url = "tools#Dashboards"
158126
weight = 9
159127
[[menu.main]]
160128
parent = "utils"
@@ -184,14 +152,14 @@ relativeURLs = false
184152
[[menu.main]]
185153
parent = "tools"
186154
name = "Archived Tools"
187-
url = "/tools/archive/"
155+
url = "tools#archive"
188156
weight = 80
189157

190158
[[menu.main]]
191159
parent = "tools"
192160
identifier = "forecasting"
193161
name = "Forecasting"
194-
url = "https://www.cdc.gov/flu/weekly/flusight/index.html"
162+
url = "tools#forecasting"
195163
weight = 50
196164

197165
[[menu.main]]
@@ -206,11 +174,64 @@ relativeURLs = false
206174
weight = 2
207175

208176
[[menu.main]]
209-
identier = "github"
177+
identier = "Packages"
178+
pre = "solid/code"
179+
name = "Packages"
180+
url = "packages"
181+
weight = 90
182+
[[menu.main]]
183+
parent = "Packages"
184+
name = "Packages overview"
185+
url = "packages"
186+
weight = 1
187+
[[menu.main]]
188+
parent = "Packages"
189+
identifier = "APIClients"
190+
name = "API and clients"
191+
url = "packages#API_and_its_clients"
192+
weight = 2
193+
[[menu.main]]
194+
parent = "APIClients"
195+
name = "Epidata"
196+
url = "https://github.com/cmu-delphi/delphi-epidata"
197+
weight = 7
198+
[[menu.main]]
199+
parent = "APIClients"
200+
name = "Epidatr"
201+
url = "https://cmu-delphi.github.io/epidatr/"
202+
weight = 8
203+
[[menu.main]]
204+
parent = "APIClients"
205+
name = "Epidatpy"
206+
url = "https://github.com/cmu-delphi/epidatpy"
207+
weight = 9
208+
209+
[[menu.main]]
210+
parent = "Packages"
211+
identifier = "forecastingCode"
212+
name = "Forecasting"
213+
url = "packages#Forecasting"
214+
weight = 10
215+
[[menu.main]]
216+
parent = "forecastingCode"
217+
name = "Forecasting Manual"
218+
weight = 1
219+
[[menu.main]]
220+
parent = "forecastingCode"
221+
name = "Epiprocess"
222+
url = "https://cmu-delphi.github.io/epiprocess/"
223+
weight = 7
224+
[[menu.main]]
225+
parent = "forecastingCode"
226+
name = "Epipredict"
227+
url = "https://cmu-delphi.github.io/epipredict/"
228+
weight = 7
229+
[[menu.main]]
230+
parent = "Packages"
231+
name = "Github"
210232
pre = "brands/github"
211-
name = "GitHub"
212233
url = "https://github.com/cmu-delphi/"
213-
weight = 90
234+
weight = 70
214235

215236

216237
[[menu.main]]

‎content/packages/_index.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Packages
3+
linkTitle: packages
4+
layout: single
5+
---
6+
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/).
7+
## API and its clients
8+
### [Epidata](https://github.com/cmu-delphi/delphi-epidata)
9+
The core server code for our [API](https://cmu-delphi.github.io/delphi-epidata/).
10+
### [Epidatr](https://cmu-delphi.github.io/epidatr/)
11+
12+
R client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
13+
It allows you to cache queries locally to speed up data access and seamlessly integrate pulling from our API into your pipelines.
14+
15+
### [Epidatpy](https://github.com/cmu-delphi/epidatpy) (WIP)
16+
17+
A work-in-progress Python client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
18+
Not yet recommended for production, but we are happy to receive feedback!
19+
20+
21+
## Forecasting
22+
### [Introduction to Epidemiological Forecasting: Delphi Tools, Data, and Lessons](https://cmu-delphi.github.io/delphi-tooling-book/)
23+
24+
An introduction to epidemiological forecasting using our tools: epiprocess and epipredict.
25+
26+
### [Epiprocess](https://cmu-delphi.github.io/epiprocess/)
27+
28+
A collection of data structures and methods for handling epidemiological data.
29+
The major features are:
30+
- The epi_df structure, which allows you track epidemiological data measured over location and time (and other potential keys).
31+
- 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.
32+
- Support for applying generic functions across a sliding time window, building on tools like [slider](https://slider.r-lib.org/). Comes with support for
33+
- handling gaps in time
34+
- automatically handling grouping of keys
35+
- 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).
36+
- Growth rate estimation, as estimated using relative rates of change, linear regression, smooth splines, or polynomial trend filtering.
37+
- Outlier detection and correction, using rolling median or LOESS trend decomposition.
38+
- Signal correlation over space, time and other keys. It also supports lagged correlations, automatically handles grouping by the specified keys, and handles time gaps.
39+
40+
### [Epipredict](https://cmu-delphi.github.io/epipredict/)
41+
42+
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:
43+
- A simple interface for defining a sequence of data pre-processing, forecasting, and post-processing steps.
44+
- A collection of data processing steps common to epidata.
45+
- A collection of pre-packaged forecasting models commonly used by Delphi's forecasting team.
46+
47+
## Deprecated Packages

‎content/tools/_index.md‎

Lines changed: 61 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,35 @@ title: Tools Overview
33
linkTitle: Tools
44
layout: single
55
---
6+
## [Delphi Epidata API](https://github.com/cmu-delphi/delphi-epidata)
7+
8+
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)).
9+
10+
## Dashboards
11+
12+
### [Delphi Epidata Dashboard](covidcast/dashboard)
13+
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.
14+
### [Indicator Status](https://delphi.cmu.edu/covidcast/indicator-status/)
15+
16+
A dashboard for displaying the lags for various signals in the Delphi Epidata API.
17+
18+
### [Dashboard Builder](https://delphi.cmu.edu/covidcast/dashboard)
19+
20+
A builder that allows you to customize the [Delphi Epidata Dashboard](/covidcast/).
21+
22+
### [EpiVis](https://delphi.cmu.edu/epivis/)
23+
24+
Epidemiological time series visualizer.
25+
26+
627

728
## Forecasting
29+
### [COVID-19 Forecasting Evaluation](https://delphi.cmu.edu/forecast-eval/)
30+
31+
We host a forecast evaluation dashboard to compare the historical performance of the forecasts submitted to the [COVID-19 Forecast Hub](https://covid19forecasthub.org/).
32+
33+
34+
835

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

@@ -18,10 +45,41 @@ We participate in weekly COVID hospital admissions forecasting at the state and
1845
Our current system for generating forecasts will be available soon [here](https://github.com/cmu-delphi/covid-hosp-forecast).
1946
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).
2047

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

23-
We host a forecast evaluation dashboard to compare the historical performance of the forecasts submitted to the [COVID-19 Forecast Hub](https://covid19forecasthub.org/).
49+
## Archived
50+
### [COVIDcast 1.0 ("Classic")](/covidcast/classic)
51+
52+
A map-first single-page webapp for visualizing COVID-19 pandemic indicators.
53+
54+
### [Crowdcast](/crowdcast)
2455

56+
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
57+
58+
### [ILI Nearby](/nowcast)
59+
60+
Flu nowcasting system.
61+
62+
**Note:** This system is designed to nowcast ILI driven by seasonal
63+
influenza and is NOT designed to nowcast ILI during the COVID-19 pandemic.
64+
65+
### [Epiforecast](https://github.com/cmu-delphi/epiforecast-R)
66+
67+
R package that implements several methods for epidemiological forecasting empirical bayes (EB), basis regression (BR), and time-weighted kernel density estimation (twkde).
68+
69+
### [Nowcast](https://github.com/cmu-delphi/nowcast)
70+
71+
A sensor fusion based nowcasting system developed to predict ILI before the COVID-19 pandemic
72+
73+
### [Fluscores](https://delphi.cmu.edu/misc/fluscores/)
74+
75+
Visual comparison of scored submissions to CDC Flu Forecasting Challenge for 2014-16 (provide your own score files).
76+
77+
### [utils](https://github.com/cmu-delphi/utils)
78+
79+
Old python utility package, mainly for handling dates and locations.
80+
81+
# Notes
82+
separate out packages into a separate tab
2583
## Packages
2684

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

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

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

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

64-
## Operational Systems
65-
66-
### [Delphi Epidata API](https://github.com/cmu-delphi/delphi-epidata)
67-
68-
API for getting up-to-date epidemiological data (also available via a web interface through [EpiVis](https://delphi.cmu.edu/epivis/epivis.html)).
69-
70-
### [Indicator Status](https://delphi.cmu.edu/covidcast/indicator-status/)
71-
72-
A dashboard for displaying the lags for various signals in the Delphi Epidata API.
73-
74-
### [Dashboard Builder](https://delphi.cmu.edu/covidcast/dashboard)
75-
76-
A builder that allows you to customize the [Delphi Epidata Dashboard](/covidcast/).
77-
78-
### [EpiVis](https://delphi.cmu.edu/epivis/)
79-
80-
Epidemiological time series visualizer.

‎content/tools/archive.md‎

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎themes/delphi/layouts/shortcodes/packages.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{ $tools := .Site.GetPage "/tools/tools" }}
2+
{{ range sort ($tools.Resources.ByType "page") "Params.order" }}
3+
<h3><a href="{{ .Params.link }}">{{ .Title }}</a></h3>
4+
{{ .Content }}
5+
{{ end }}

0 commit comments

Comments
 (0)