https://github.com/substance/dar

Reproducible Document Archive
https://github.com/substance/dar

Last synced: 3 days ago
JSON representation

Reproducible Document Archive

• Host: GitHub
• URL: https://github.com/substance/dar
• Owner: substance
• Created: 2017-12-18T12:15:37.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-04T10:18:03.000Z (almost 6 years ago)
• Last Synced: 2024-10-29T22:25:04.750Z (14 days ago)
• Homepage:
• Size: 504 KB
• Stars: 82
• Watchers: 16
• Forks: 9
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dar

Dar stands for (Reproducible) Document Archive and specifies a virtual file format that holds multiple digital documents, complete with images and other assets. A Dar consists of a manifest file (`manifest.xml`) that describes the contents.

```xml

  

    

    

  

  

    

  

```

There are two types of contents:

- Documents:  Those are meant to be manipulated by a visual editor, and typically stored as XML/HTML or JSON.

- Assets: Regular files which can be used from any document. For instance, two documents could embed the same image.

## Designed for research and scientific publishing

Dar is being designed for storing [reproducible research publications](https://elifesciences.org/labs/7dbeb390/reproducible-document-stack-supporting-the-next-generation-research-article), but the underlying concepts are suitable for any kind of digital publications that can be bundled together with their assets.

## Goals

- Establish standardised research publications

- Self-contained archive (includes manuscript, images, source code and data)

- Machine-friendly format to ease development of tools

- Long-term preservation

- Stand-alone, offline execution of reproducible elements

- Language agnostic (e.g. run Python, R, Jupyter, Kernels etc.)

- Tool agnostic (use Jupyter, RMarkdown or Stencila for authoring)

## Specifications

The following specifications define a markup language (XML) for research articles and spreadsheets:

- [Texture Article](https://github.com/substance/texture/blob/master/docs/TextureArticle.md): An XML format, based on JATS, the de facto standard for archiving and interchange of scientific open-access contents with XML

## Editors

The following editors are developed to edit document archives of research projects:

- [Stencila](https://github.com/stencila/stencila): an office suite for reproducible research

- [Texture](https://github.com/substance/texture): an open source manuscript editor designed for publishers and authors

## Examples

These two examples are continuously updated, to reflect the latest versions of the related specifications.

- [Classic Research Manuscript](https://github.com/substance/texture/tree/master/data/kitchen-sink): Editable in Texture

- [Reproducible Research Publication](https://github.com/stencila/stencila/tree/develop/examples/kitchen-sink): Editable and runnable with Stencila

## Status

This is an early stage proposal (alpha) that will be continuously advanced. We are using existing standards when possible (such as JATS-XML for representing articles) and seek for consensus in the research community to offer the most flexible and concise tagging guidelines.

## License

The JATS Standard is copyrighted by NISO, but all of the non-normative 

information found in this repository is in the CC BY-SA 4.0.

More info at https://creativecommons.org/licenses/by-sa/4.0/

## Credits

Dar is developed by the [Substance Consortium](http://substance.io/consortium/), an open community formed by the Public Knowledge Project (PKP), the Collaborative Knowledge Foundation (CoKo), SciELO, Érudit, eLife and Stencila.