Skip to content
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

Update README.md #30

Merged

Conversation

skirmer
Copy link
Member

@skirmer skirmer commented Feb 6, 2017

No description provided.

@jenniferthompson
Copy link
Contributor

Looks awesome @skirmer! A couple comments to streamline -

  • I'd just link "CMS.gov" in the Original Source section to the link you have in the doc
  • Could you add a sentence to quickly summarize what the dataset contains? Along the lines of "This is a table showing drug brand names and other information alongside manufacturers" or whatever other description makes sense?
  • For the README, we're aiming for a quick snapshot of what each data source can broadly tell us, then we'll include specific details in the data dictionary for when people see the summary and then want to dig into it. I think in this case, info like ASOFDATE and the 2016-17 note would be good examples of data dictionary info (here's the current data dictionary template - very helpful and necessary, and better suited for the dictionary than the overview so they get proper attention at the right time.

I'll add a note to the README to clarify what should go there vs the data dictionary!

I hope this is better- I'll work on a dictionary as soon as I get a chance.
@jenniferthompson
Copy link
Contributor

Love it @skirmer! Thank you! Merging now.

@jenniferthompson jenniferthompson merged commit b64cd61 into Data4Democracy:data-dictionaries Feb 6, 2017
@skirmer skirmer deleted the data-dictionaries branch February 6, 2017 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants