You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _template_python/INDICATOR_DEV_GUIDE.md
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -181,7 +181,7 @@ To get started, Delphi has a [basic code template](https://github.com/cmu-delphi
181
181
It can also be helpful to read through other indicators, especially if they share a data source or format.
182
182
183
183
Indicators should be written in python for speed and maintainability.
184
-
If you think you need to use R, please reconsider! and talk to other engineering team members.
184
+
Don't use R.
185
185
186
186
Generally, indicators have:
187
187
@@ -240,7 +240,7 @@ After that, generalize your code to be able to be run on all geos of interest, t
240
240
Make sure you have a functional environment with python 3.8.15+.
241
241
For local runs, the makefile’s make install target will set up a local virtual environment with necessary packages.
242
242
243
-
(If working in R (not recommended), local runs can be run without a virtual environment or using the [`renv` package](https://rstudio.github.io/renv/articles/renv.html), but production runs should be set up to user Docker.)
243
+
(If working in R (very much NOT recommended), local runs can be run without a virtual environment or using the [`renv` package](https://rstudio.github.io/renv/articles/renv.html), but production runs should be set up to use Docker.)
244
244
245
245
#### Dealing with data-types
246
246
@@ -306,12 +306,13 @@ Ideally, the indicator name should:
306
306
Based on these guidelines, the `jhu-csse` indicator would be better as `jhu-csse` everywhere (module name could be `delphi_jhu_csse`), rather than having a mix of `jhu-csse` and `jhu`.
307
307
308
308
Signal names should not be too long, but the most important feature is that they are descriptive.
309
+
If we're mirroring a processed dataset, consider keeping their signal names.
309
310
310
-
Some standard tags used in signal names:
311
+
Use the following standard tags when creating new signal names:
311
312
312
313
*`raw`: unsmoothed, _no longer used; if no smoothing is specified the signal is assumed to be "raw"_
313
314
*`7dav`: smoothed using a average over a rolling 7-day window; comes at the end of the name
314
-
*`smoothed`: smoothed using a more complex smoothing algorithm
315
+
*`smoothed`: smoothed using a more complex smoothing algorithm; comes at the end of the name
315
316
*`prop`: counts per 100k population
316
317
*`pct`: percentage between 0 and 100
317
318
*`num`: counts, _no longer used; if no value type is specified the signal is assumed to be a count_
0 commit comments