NationalGalleryOfArt / opendata

The National Gallery of Art Open Data Program
https://www.nga.gov/open-access-images/open-data.html
Creative Commons Zero v1.0 Universal
358 stars 64 forks source link

Review updated data dictionary. #8

Open brwz-nga opened 2 years ago

brwz-nga commented 2 years ago

Review updated data dictionary.

Data Dictionary (1).docx

beaudet commented 1 year ago

reviewed and revised - will commit to main after approving the pull request

thisisaaronland commented 1 year ago

It is possible to publish copies of these documents as not-Word files?

beaudet commented 1 year ago

Sure. What format(s) would you prefer?

beaudet commented 1 year ago

Data.Dictionary.docx Updated MS Word version with a few minor edits.

thisisaaronland commented 1 year ago

In the interest of not making More Work (tm) for anyone a plain-text version would be great. A Markdown version would be a pretty and shiny addition to the GitHub repo but I don't know whether Word exports to Markdown.

Ideally (in the More Work for Everyone (tm) department) it would be nice to have a machine readable catalog of properties. Something along the lines of:

beaudet commented 1 year ago

Thanks for the request and suggestions. I was wondering if you were asking for a more open document format than MS Word but it sounds like your request is more about machine readable properties. Since that will take a bit more time than a "Save as", I'll leave this issue open until someone on the team has time to work on building a machine readable catalog from the data dictionary.

thisisaaronland commented 1 year ago

Machine-readable would be ideal but, in the short-term, a plain-text version would be fine.

bzweig633 commented 1 year ago

Please take a look at the data dictionary as a plain-text file. Data Dictionary.txt

thisisaaronland commented 1 year ago

Thanks!

The formatting is a bit off. Specifically there aren't newlines between headers and paragraphs and there appear to be encoding issues with things like apostrophes. For example:

National Gallery of Art Open Data Program: Collection Data in CSV Format

Introduction
Thank you for your interest in data about the National Gallery of Art<92>s collection.  The comma separated value files contained on this GitHub site represent a cross-section of public, fact-based data about our collection.  They contain an export of data about the NGA<92>s accessioned art objects, relationships between those art objects, the creators of those objects, donors who helped the NGA acquire the objects, the object<92>s provenance, and the public locations where the collection can be viewed, as well as links to access audio and video about the collection and people and images depicting the works. The NGA is releasing these files under the Creative Commons Zero (CC0) designation.  You are free to use the data in any manner consistent with the CC0 designation. Please note that while links to media files and images contained in this data are being released under a CC0 designation, the content of the linked sites might still be copyrighted. The NGA<92>s Open Access Policy, for example, applies to only a subset of the images that are linked in this dataset.
The full dataset is updated frequently (usually once a day), and the date of a particular CSV file can be confirmed by examining the last commit date reported by GitHub. 
We appreciate your feedback and questions about the NGA<92>s open data program and are interested in learning about all the innovative ways that people are using our data, so please let us know!
The remainder of this document describes the data elements comprising the CSV formatted open dataset.

About Objects and Constituents 
Art Objects comprise collections and are therefore one of two typical starting points for exploring a collection.  The Object Identifier, a.k.a., <93>objectID<94> is a unique sequential identifier assigned by the CMS system to each new art object registered in the collection management system.  The objectID is used to link many tables with the objects table which is the core table of the collection.
bzweig633 commented 1 year ago

Thanks for catching those things. I've reformatted the txt file and re-encoded it in UTF-8 for proper character rendering. Data Dictionary.txt

beaudet commented 1 year ago

Next step to resolving this issue will be production of a machine readable properties.

brwz-nga commented 1 year ago

I've replaced the Word file with the plan text file. Leaving the issue open until, as above, we produce machine readable properties for it.