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

Clarify DataPackage File Info Section #30

Closed
trestletech opened this issue Apr 5, 2013 · 4 comments
Closed

Clarify DataPackage File Info Section #30

trestletech opened this issue Apr 5, 2013 · 4 comments

Comments

@trestletech
Copy link
Contributor

I'm unclear on the File Info Section on the Data Package documentation. Specifically:

  1. Is a name/ID not a required/suggested attributed for a file? Foreign Key attribute in JSON schema #23 seems to imply that this information would be required for each file. Of course, if files were a hash, each file element could be named explicitly in a pretty natural way. Currently, it's listed as an array.
  2. What combination of data is expected/required? Would one use the schema key be used only if the file were in the JSON Table Schema, while the dialect key would be used for CSVs? Or should they both always be supplied?

I'm working on the ability to retrieve data files from a specified Data Package JSON file in the R client and need to figure these two things out in order to proceed.

@trestletech
Copy link
Contributor Author

Alternatively, perhaps the ID/Name should be specified within each JSON Table Schema?

@rufuspollock
Copy link
Contributor

@trestletech good questions.

  1. On name/id i've booted a dedicated issue Files should have a required name (or id) attribute #32
  2. Requirements: only one of url or path is strictly necessary at the moment. If you do have a CSV file then the schema should be there (and dialect should be present if not defaults). So I think you can proceed on the basis that for data package you would handle schema will always be there.

@trestletech
Copy link
Contributor Author

Great. If we can get my pull request merged, I'd be happy to create another one to clarify the docs on this.

@rufuspollock
Copy link
Contributor

@trestletech you may actually also want to look at http://www.dataprotocols.org/en/latest/simple-data-format.html which builds on data packages and json table schema adding additional requirements and restrictions. To be clear:

  • A Simple Data Format dataset IS A data package
  • Simple Data Format USES data package spec and json table schema spec

roll added a commit that referenced this issue Jun 26, 2024
* Updated the spec

* Updated the profile

* Updated letter case

* Updated json formatting

* Updated the example

* Fixed profile

* Added `non-empty array`

* Improved wording
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants