From 4050979ff2b954976406fca7dd9251e2474b2718 Mon Sep 17 00:00:00 2001 From: Alex Reinhart Date: Mon, 6 Jul 2020 19:16:15 +0000 Subject: [PATCH] Require documentation of missingness in source template --- docs/api/covidcast-signals/_source-template.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index f2d373167..137d7f38a 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -62,6 +62,16 @@ geographic coverage, limits in its interpretation (symptoms in a survey aren't always caused by COVID, our healthcare partner only is part of the market, there may be a demographic bias in respondents, etc.), known inaccuracies, etc. +## Missingness + +Describe *all* situations under which a value may not be reported, and what that +means. If the signal ever reports NA, describe what that means and how it is +different from missingness. For example: + +When fewer than 100 survey responses are received in a geographic area on a +specific day, no data is reported for that area on that day; an API query for +all reported geographic areas on that day will not include it. + ## Lag and Backfill If this signal is reported with a consistent lag, describe it here.