Skip to content

Commit

Permalink
Changes in index file, added first_steps and faqs
Browse files Browse the repository at this point in the history
  • Loading branch information
agbeltran committed Oct 27, 2016
1 parent b4578ef commit d13cb14
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 11 deletions.
3 changes: 3 additions & 0 deletions docs/source/faqs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
##########################
Frequently Asked Questions
##########################
24 changes: 24 additions & 0 deletions docs/source/first_steps.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#####################
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:
-----------------------------

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:
-------------------------------

DATS records key *Date*(s) about the *Dataset*.

Each *Date* can specify its type, related to the event related to the key date (e.g. creation, update, validation, verification, deprecation of the dataset).

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.



32 changes: 21 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,45 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to BioCADDIE DATS's documentation
Welcome to bioCADDIE DATS's documentation
=========================================

Contents:
Introduction:
-------------

DATS, which stands for DAta Tag Suite, is a data description model designed and developed to describe datasets being ingested in `DataMed <http://datamed.org>`_, a prototype for data discovery developed as part of the `NIH Big Data 2 Knowledge <https://datascience.nih.gov/bd2k>`_ `bioCADDIE project <http://biocaddie.org/>`_. For more information about the objectives of the bioCADDIE project, please have a look at the `bioCADDIE White Paper <https://dx.doi.org/10.6084/m9.figshare.1362572.v1>`_.

This documentation describes the DATS model and how to use it. More details about how DATS was designed and how it relates to other models can be found in the `documents accompanying each of the releases <https://github.com/biocaddie/WG3-MetadataSpecifications/tree/master/doc>`_.

Table of Contents:

.. toctree::
:maxdepth: 2
:numbered:

first_steps
dats
dataset_provenance
dataset_about
dataset_distribution
dataset_creator

dataset_about
dataset_provenance
faqs

License:
--------

BioCADDIE DATS is licensed under `Creative Commons Attribution Share-Alike 4.0 <https://creativecommons.org/licenses/by-sa/4.0/legalcode>`_.

Contribute:
-----------
-Issue Tracker: https://github.com/biocaddie/WG3-MetadataSpecifications/issues
Contributing:
-------------

If you wish to contribute to DATS and/or this documentation, please report issues in our `tracker <https://github.com/biocaddie/WG3-MetadataSpecifications/issues>`_
or contact us directly (`agbeltran <https://github.com/agbeltran>`_ and `proccaserra <https://github.com/proccaserra>`_.

-Source Code: https://github.com/biocaddie/WG3-MetadataSpecifications
The different releases of DATS are available in the `bioCADDIE Working Group 3 Github Repository <https://github.com/biocaddie/WG3-MetadataSpecifications>`_, including documents and appendixes, JSON schemas, JSON-LD context files and JSON-LD instance files.

Indices and tables
==================
Indices and tables:
===================

* :ref:`genindex`
* :ref:`modindex`
Expand Down

0 comments on commit d13cb14

Please sign in to comment.