-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
nssp documentation draft #1439
nssp documentation draft #1439
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
More detail needed for a couple topics. @minhkhul is probably the best person for some of them.
I moved stuff around and reworded some things, so please look over my changes.
docs/api/covidcast-signals/nssp.md
Outdated
This data source has frequent backfill, primarily arising from newly included EDs. When a new facility joins the reporting network, its historical data is added to the dataset, resulting in changes to historical values for every geographic level that ED is part of (county through nation). Because of this, the broadest geographic levels are more likely to be revised. | ||
|
||
In previous revisions, we have noted changes to values dating back about 2 years. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: ideally, we'd have more detail here. For example,
- how often do revisions happen?
- how often are new facilities added?
- are there any patterns to where new facilities are added?
- how much do values change as a result?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a similar revision analysis posted on the other sources? I don't ever remember seeing them. I agree it would be useful, but that sounds more like an overall doc overhaul thing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have this type of info for some sources. It's something that Roni has requested more detail about recently and that we've wanted info about for various signals at various points in time.
I don't think this is critical to add now, but it will be easiest, since we've done the statistical analysis recently. I was hoping that @minhkhul or you had come across info about this during the analysis.
Questions about are some things that came to mind but are more guiding questions for the type of detail I'd be looking for. They don't all need to be answered exactly, but any additional info would be helpful.
Ultimately, this is up to y'all.
@tinatownes do you see anything here that is missing compared to the source doc pages? |
docs/api/covidcast-signals/nssp.md
Outdated
|---------------------------------|-------------------------------------------------------------------------| | ||
| `pct_visits_covid` | Percent of ED visits that had a discharge diagnosis code of covid | | ||
| `pct_visits_influenza` | Percent of ED visits that had a discharge diagnosis code of influenza | | ||
| `pct_visits_rsv` | Percent of ED visits that had a discharge diagnosis code of rsv | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: this is late in the game, so optional change, but signal names would be clearer as pct_er_visits_*
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pct_ed_visits_*
? I'm still not sure about the difference tbh. I'd leave it up to Minh, as she'd have the most to change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was considering "ed", but it's not how laypeople refer to it. As far as I'm aware, only healthcare workers call the ER the "ED". So I think for a more general audience, "er" is clearer, although it does differ from the dataset name.
Will ask Roni
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nmdefries, sorry I'm late here!
Minor suggestion: In the TOC, consider adding a link to the "Overview" to maintain consistency with the TOCs of signals such as "Change Healthcare" and "Doctor Visits".
Nothing else stands out, the headings are great. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for looking! Though I don't really follow what you mean. When I look at the table of contents in doctor-visits
:
delphi-epidata/docs/api/covidcast-signals/doctor-visits.md
Lines 30 to 36 in e423cb4
## Table of Contents | |
{: .no_toc .text-delta} | |
1. TOC | |
{:toc} | |
## Estimation |
it seems just the same as what's here?
delphi-epidata/docs/api/covidcast-signals/nssp.md
Lines 35 to 40 in 28482cf
## Table of contents | |
{: .no_toc .text-delta} | |
1. TOC | |
{:toc} | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Waiting for a response from Roni about naming
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dsweber2 sorry for the confusion: you can prob just ignore my comment! I think the "Overview" section I'm pointing to may be contained in the {:toc} . Here's a visual where in doctor's visits the TOC has "Overview" circled in red:
Thanks!
Co-authored-by: nmdefries <42820733+nmdefries@users.noreply.github.com>
docs/api/covidcast-signals/nssp.md
Outdated
|
||
## Missingness | ||
|
||
As of May 2024, NSSP received data from 78% of US EDs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a link for this number?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's on the very bottom of the main NSSP index. Felt a little redundant linking to it again, but could definitely include
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From Roni, let's rename the signals by prefixing "visits" with "ed", e.g. pct_visits_covid
to pct_ed_visits_covid
.
This is ready to go whenever that is finished.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
Quality Gate passedIssues Measures |
Summary:
This adds documentation for NSSP
Prerequisites:
dev
branchdev