Skip to content

Commit

Permalink
Adding more info to faqs and first_steps
Browse files Browse the repository at this point in the history
  • Loading branch information
agbeltran committed Oct 27, 2016
1 parent d13cb14 commit 20a52ee
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/source/faqs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
##########################
Frequently Asked Questions
##########################

Why are some properties (e.g. "title" and "description") included in both Dataset and DataDistribution?
--------------------------------------------------------------------------------------------------------
When designing DATS we chose to be flexible and consider some redundancy by including properties in both Dataset as well as DatasetDistribution,
even though in some cases it might be expected that a Dataset property should be inherited by their DatasetDistributions. We followed this approach
to cover cases where repositories may have different information. For example, it would be possible that each DatasetDistribution has more
information in its "description" on how the distribution was produced, adding more details to the general information in the corresponding Dataset.
17 changes: 15 additions & 2 deletions docs/source/first_steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ First Steps with DATS

This document gives an overview of the DATS components from a practical perspective, i.e. considering how DATS is used to describe a specific dataset considering a set of questions that determine the dataset provenance.

**Who** produced the dataset:
*Who* produced the dataset:
-----------------------------

DATS records the *Person* (s) and *Organization* (s) associated with the dataset.
In addition, it supports documenting their roles (e.g. creator, curator, developer, funder, principal investigator)


**When** was the data produced:
*When* was the data produced:
-------------------------------

DATS records key *Date*(s) about the *Dataset*.
Expand All @@ -21,4 +21,17 @@ Each *Date* can specify its type, related to the event related to the key date (
This mechanism of providing a generic *Date* indicating its type allows for extensions to new types of dates, which may be required in specific scenarios.


*What* is the dataset about:
--------------------------
DATS records the nature of information available in a dataset through the data type object.


*Why* was the data produced:
----------------------------
DATS supports to document the purpose, objective or hypothesis that gave origin to the dataset.


*Where* and *How* the dataset can be accessed:
----------------------------------------------


0 comments on commit 20a52ee

Please sign in to comment.