Skip to content

Commit d4001c2

Browse files
committed
refactor: tools and code updates
* fix some broken header links * consistent capitalization * rename Packages to Code * remove unused shortcodes * change landing page Our API to Our Tools and link to tools page * update the footer to contain a link to Code
1 parent b7c3883 commit d4001c2

File tree

8 files changed

+55
-106
lines changed

8 files changed

+55
-106
lines changed

config.toml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ relativeURLs = false
122122
parent = "tools"
123123
identifier = "utils"
124124
name = "Dashboards"
125-
url = "tools#Dashboards"
125+
url = "/tools/#dashboards"
126126
weight = 9
127127
[[menu.main]]
128128
parent = "utils"
@@ -151,15 +151,15 @@ relativeURLs = false
151151
weight = 50
152152
[[menu.main]]
153153
parent = "tools"
154-
name = "Archived Tools"
155-
url = "tools#archive"
154+
name = "Archived"
155+
url = "/tools/#archived"
156156
weight = 80
157157

158158
[[menu.main]]
159159
parent = "tools"
160160
identifier = "forecasting"
161161
name = "Forecasting"
162-
url = "tools#forecasting"
162+
url = "/tools/#forecasting"
163163
weight = 50
164164

165165
[[menu.main]]
@@ -174,21 +174,21 @@ relativeURLs = false
174174
weight = 2
175175

176176
[[menu.main]]
177-
identier = "Packages"
177+
identier = "Code"
178178
pre = "solid/code"
179-
name = "Packages"
180-
url = "packages"
179+
name = "Code"
180+
url = "code"
181181
weight = 90
182182
[[menu.main]]
183-
parent = "Packages"
184-
name = "Packages overview"
185-
url = "packages"
183+
parent = "Code"
184+
name = "Code Overview"
185+
url = "code"
186186
weight = 1
187187
[[menu.main]]
188-
parent = "Packages"
188+
parent = "Code"
189189
identifier = "APIClients"
190-
name = "API and clients"
191-
url = "packages#API_and_its_clients"
190+
name = "API and Clients"
191+
url = "/code/#api-and-clients"
192192
weight = 2
193193
[[menu.main]]
194194
parent = "APIClients"
@@ -207,10 +207,10 @@ relativeURLs = false
207207
weight = 9
208208

209209
[[menu.main]]
210-
parent = "Packages"
210+
parent = "Code"
211211
identifier = "forecastingCode"
212212
name = "Forecasting"
213-
url = "packages#Forecasting"
213+
url = "code#forecasting"
214214
weight = 10
215215
[[menu.main]]
216216
parent = "forecastingCode"
@@ -227,16 +227,15 @@ relativeURLs = false
227227
url = "https://cmu-delphi.github.io/epipredict/"
228228
weight = 7
229229
[[menu.main]]
230-
parent = "Packages"
230+
parent = "Code"
231231
name = "Github"
232232
pre = "brands/github"
233233
url = "https://github.com/cmu-delphi/"
234234
weight = 70
235235

236-
237236
[[menu.main]]
238237
identifier = "api"
239-
name = "API"
238+
name = "Epidata API"
240239
pre = "solid/database"
241240
url = "https://cmu-delphi.github.io/delphi-epidata/"
242241
weight = 100
@@ -245,6 +244,7 @@ relativeURLs = false
245244
description = "Developing the Theory and Practice of Epidemiological Forecasting"
246245
mission = "Develop the theory and practice of epidemiological tracking and forecasting, with a long-term vision of making this technology as universally accepted and useful as weather forecasting is today."
247246
apiUrl = "https://cmu-delphi.github.io/delphi-epidata"
247+
toolUrl = "/tools/"
248248
twitter = "CmuDelphi"
249249
contactForm = "https://docs.google.com/forms/d/e/1FAIpQLScqgT1fKZr5VWBfsaSp-DNaN03aV6EoZU4YljIzHJ1Wl_zmtg/viewform"
250250
feedbackForm = "https://docs.google.com/forms/d/e/1FAIpQLSeIeOJtrAhdOriEyiRY7LkpQX8DZBY19dl6De8l56Q9CZhmxw/viewform?usp=pp_url&entry.1245962748="

content/packages/_index.md renamed to content/code/_index.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
2-
title: Packages
3-
linkTitle: packages
2+
title: Code Overview
3+
linkTitle: Code
44
layout: single
55
---
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
6+
7+
In addition to the Delphi Epidata API server code, we have a number of user-oriented code packages, such as API clients and time-series modeling for epidemiology.
8+
All source code is freely available on [GitHub](https://github.com/cmu-delphi/).
9+
10+
## API and clients
11+
812
### [Epidata](https://github.com/cmu-delphi/delphi-epidata)
9-
The core server code for our [API](https://cmu-delphi.github.io/delphi-epidata/).
13+
14+
The core server code for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
15+
1016
### [Epidatr](https://cmu-delphi.github.io/epidatr/)
1117

1218
R client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
@@ -17,8 +23,8 @@ It allows you to cache queries locally to speed up data access and seamlessly in
1723
A work-in-progress Python client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
1824
Not yet recommended for production, but we are happy to receive feedback!
1925

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

2430
An introduction to epidemiological forecasting using our tools: epiprocess and epipredict.
@@ -45,3 +51,15 @@ A framework for building epidata pipelines involving transformation and forecast
4551
- A collection of pre-packaged forecasting models commonly used by Delphi's forecasting team.
4652

4753
## Deprecated Packages
54+
55+
### [Covidcast](https://github.com/cmu-delphi/covidcast)
56+
57+
A collection of R and Python packages for accessing and analyzing data from the Delphi COVIDcast API.
58+
59+
### [Epiforecast](https://github.com/cmu-delphi/epiforecast-R)
60+
61+
R package that implements several methods for epidemiological forecasting empirical bayes (EB), basis regression (BR), and time-weighted kernel density estimation (twkde).
62+
63+
### [utils](https://github.com/cmu-delphi/utils)
64+
65+
Python utility package for handling dates and locations.

content/tools/_index.md

Lines changed: 7 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@ title: Tools Overview
33
linkTitle: Tools
44
layout: single
55
---
6+
67
## [Delphi Epidata API](https://github.com/cmu-delphi/delphi-epidata)
78

89
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)).
910

1011
## Dashboards
1112

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.
13+
### [Delphi Epidata Dashboard](covidcast/)
14+
15+
The primary dashboard to interact with Delphi Epidata. If you wish to access the results programmatically, see the API above or one of its clients.
16+
1417
### [Indicator Status](https://delphi.cmu.edu/covidcast/indicator-status/)
1518

1619
A dashboard for displaying the lags for various signals in the Delphi Epidata API.
@@ -23,16 +26,12 @@ A builder that allows you to customize the [Delphi Epidata Dashboard](/covidcast
2326

2427
Epidemiological time series visualizer.
2528

26-
27-
2829
## Forecasting
30+
2931
### [COVID-19 Forecasting Evaluation](https://delphi.cmu.edu/forecast-eval/)
3032

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

33-
34-
35-
3635
### [Flu Forecasting (FluSight)](https://www.cdc.gov/flu/weekly/flusight/index.html)
3736

3837
We participate in the weekly Flu forecasting hub run by the CDC during the flu season.
@@ -45,8 +44,8 @@ We participate in weekly COVID hospital admissions forecasting at the state and
4544
Our current system for generating forecasts will be available soon [here](https://github.com/cmu-delphi/covid-hosp-forecast).
4645
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).
4746

48-
4947
## Archived
48+
5049
### [COVIDcast 1.0 ("Classic")](/covidcast/classic)
5150

5251
A map-first single-page webapp for visualizing COVID-19 pandemic indicators.
@@ -62,60 +61,10 @@ Flu nowcasting system.
6261
**Note:** This system is designed to nowcast ILI driven by seasonal
6362
influenza and is NOT designed to nowcast ILI during the COVID-19 pandemic.
6463

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-
6964
### [Nowcast](https://github.com/cmu-delphi/nowcast)
7065

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

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

7570
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
83-
## Packages
84-
85-
All source code is freely available on [GitHub](https://github.com/cmu-delphi/).
86-
87-
### [Epidatr](https://cmu-delphi.github.io/epidatr/)
88-
89-
R client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
90-
It allows you to cache queries locally to speed up data access and seamlessly integrate pulling from our API into your pipelines.
91-
92-
### [Epidemiological Forecasting with Delphi Tooling Packages](https://cmu-delphi.github.io/delphi-tooling-book/)
93-
94-
An introduction to epidemiological forecasting using our tools: epiprocess and epipredict.
95-
96-
### [Epiprocess](https://cmu-delphi.github.io/epiprocess/)
97-
98-
A collection of data structures and methods for handling epidemiological data.
99-
The major features are:
100-
- The epi_df structure, which allows you track epidemiological data measured over location and time (and other potential keys).
101-
- 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.
102-
- Support for applying generic functions across a sliding time window, building on tools like [slider](https://slider.r-lib.org/). Comes with support for
103-
- handling gaps in time
104-
- automatically handling grouping of keys
105-
- 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).
106-
- Growth rate estimation, as estimated using relative rates of change, linear regression, smooth splines, or polynomial trend filtering.
107-
- Outlier detection and correction, using rolling median or LOESS trend decomposition.
108-
- Signal correlation over space, time and other keys. It also supports lagged correlations, automatically handles grouping by the specified keys, and handles time gaps.
109-
110-
### [Epipredict](https://cmu-delphi.github.io/epipredict/)
111-
112-
A framework for building epidata pipelines involving transformation and forecasting. It is built on top of epiprocess and provides a simple interface for defining and running pipelines. It supports:
113-
- A simple interface for defining a sequence of data pre-processing, forecasting, and post-processing steps.
114-
- A collection of data processing steps common to epidata.
115-
- A collection of pre-packaged forecasting models commonly used by Delphi's forecasting team.
116-
117-
### [Epidatpy](https://github.com/cmu-delphi/epidatpy) (WIP)
118-
119-
A work-in-progress Python client for the [Delphi Epidata API](https://cmu-delphi.github.io/delphi-epidata/).
120-
Not yet recommended for production, but we are happy to receive feedback!
121-

themes/delphi/layouts/landing.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ <h2>Our Team</h2>
2929
<img src="{{ ($img).RelPermalink }}" width="288" height="296" alt="API Image" />
3030
</picture>
3131
</div>
32-
<h2>Our API</h2>
32+
<h2>Our Tools</h2>
3333
<p>Access our data and tools</p>
34-
{{ partial "arrow-link.html" (dict "link" .Site.Params.apiUrl "alt" "Learn more") }}
34+
{{ partial "arrow-link.html" (dict "link" .Site.Params.toolUrl "alt" "Learn more") }}
3535
</div>
3636
</div>
3737
</div>

themes/delphi/layouts/partials/footer.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ <h5 class="uk-text-bold">Resources</h5>
2828
<li>
2929
<a class="uk-link-text uk-text-small" href="{{ relref . "/tools" }}">Tools</a>
3030
</li>
31-
<li><a class="uk-link-text uk-text-small" href="{{ .Site.Params.apiUrl }}/">API</a></li>
31+
<li>
32+
<a class="uk-link-text uk-text-small" href="{{ relref . "/code" }}">Code</a>
33+
</li>
34+
<li><a class="uk-link-text uk-text-small" href="{{ .Site.Params.apiUrl }}/">Epidata API</a></li>
3235
<li><a class="uk-link-text uk-text-small" href="https://github.com/cmu-delphi/">GitHub</a></li>
3336
</ul>
3437
</div>

themes/delphi/layouts/shortcodes/packages.html

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

themes/delphi/layouts/shortcodes/systems.html

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

themes/delphi/layouts/shortcodes/tools.html

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

0 commit comments

Comments
 (0)