ya2ro 0.0.3

Tool to which you pass basic information of a project or a research article (such as the datasets, software, people who have been involved, bibliography...) and generates two files with structured information with the intention of easing the readability for machines and people. One file is a webpage with all the relevant information and the other one is a Research Object.

ya2ro

Demo

https://oeg-upm.github.io/ya2ro/output/landing_page.html

Installation

To run ya2ro, please follow the next steps:

Install from PyPI

pip install ya2ro

Install from GitHub

git clone https://github.com/oeg-upm/ya2ro
cd ya2ro
pip install -e .

Test ya2ro installation

ya2ro --help

If everything goes fine, you should see:

                        ad888888b,
                       d8"     "88
                               a8P
8b       d8 ,adPPYYba,      ,d8P"  8b,dPPYba,  ,adPPYba,
`8b     d8' ""     `Y8    a8P"     88P'   "Y8 a8"     "8a
 `8b   d8'  ,adPPPPP88  a8P'       88         8b       d8
  `8b,d8'   88,    ,88 d8"         88         "8a,   ,a8"
    Y88'    `"8bbdP"Y8 88888888888 88          `"YbbdP"'
    d8'
   d8'
_________________________________________________________

usage: ya2ro [-h] (-i INPUT | -l LANDING_PAGE) [-o OUTPUT_DIRECTORY] [-p PROPERTIES_FILE]

Human and machine readable input as a yaml file and create RO-Object in jsonld and/or HTML view.

options:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Path of the required yaml input. Follow the documentation or the example given to see the structure of the file.
  -l LANDING_PAGE, --landing_page LANDING_PAGE
                        Path of a previous output folder using the ya2ro tool. This flag will make a landing page to make all the resources accesible.
  -o OUTPUT_DIRECTORY, --output_directory OUTPUT_DIRECTORY
                        Output diretory.
  -p PROPERTIES_FILE, --properties_file PROPERTIES_FILE
                        Properties file name.

---

How to use

The first thing to do is create some input for ya2ro. To create valid a yalm you should follow the documentation bellow.

Create a yalm from scratch or use one of the supplied templates. Currently ya2ro supports two formats:

• paper
• project

Please find a template for each type under the directory templates. Once you have a valid yalm (proyect or paper) is time to run ya2ro.

Create machine and human readable content

It is possible to process batches of yalms at the same time, to do that just specify as input a folder with all the yalms inside.

Simple execution

ya2ro -i templates

ya2ro -i templates/project_yemplate.yaml

With optional arguments

ya2ro -input templates --output_directory out --properties_file custom_properties.yaml

ya2ro -i templates -o out -p custom_properties.yaml

Create landing page

ya2ro offers the option to create a landing page where all the resources produced are easilly accesible. Just indicate the folder where this resources are, for example:

ya2ro -l output

---

Fields supported

Paper

Documentation for all supported fields for type paper.

type:This field is required and is used to indicate the type of the work.

type: "paper"

doi_paper:All the relevant information of the paper will be retrieved. Such as:

• Title
• Summary
• Bibtext
• Citation/Bibliography
• Authors

doi_paper: https://doi.org/xxxxxxxxx

title:Title of the paper.

title: "Paper - Template"

summary:A brief summary of the paper, also known as an abstract.

summary: "This is a summary of the paper."

datasets: All the datasets used and created during the paper. This tool supports to define each dataset manually specifying all fields or to use a DOI and ya2ro will try to automatically fetch the data.

datasets:
  - 
    doi_dataset: www.doiDB1.com
  - 
    link: www.D1.com 
    name: "Dataset 1"
    description: "Description dataset 1"
    license: "MIT-License"
    author: "Author name"

software: All the relevant software used and created for the paper. If a GitHub Repo is provided ya2ro will use SOMEF to automatically fetch relevant data.

software:
  -
    link: https://github.com/KnowledgeCaptureAndDiscovery/somef/
  - 
    link: http://software_1.com 
    name: "Software 1"
    description: "Description software 1"
    license: "MIT-License"

bibliography:In this field is where the bibliography can be added.

bibliography:
  - "Bibliography entry 1"
  - "Bibliography entry 2"
  - "Bibliography entry 3"

authors:In this field is where credit to the creators, collaborators, authors, etc is given. If an ORCID is privided, ya2ro will fetch relevant data automatically. If a photo is not provided, a default one will be used.

authors:
    -
      orcid: https://orcid.org/0000-0003-0454-7145
      role: "Coordinator"
    -
      name: "Author"
      position: "Author's position"
      description: "Author's description"
      web: https://author-web.com/
      photo: "author_photo.jpg"

---

Project

Documentation for all supported fields for type project.

type:This field is required and is used to indicate the type of the work.

type: "project"

title:Title of the project.

title: "Project - Template"

goal:In this field you should inlcude the goal for the project.

goal: "Here is where a description of what is this project trying to achieve."

social_motivation:In this field you should include why this project will help in a social way.

social_motivation: "This is the social motivation behind this project."

sketch:Path to an image where a visual description/workflow is shown.

sketch: "images/sketch_ya2ro.jpg"

areas:All the areas involucrated inside this project.

areas: 
  - "Area 1: Some description."
  - "Area 2: Some description."

activities:All the idividual subtasks of the project.

activities:
  - "Subtask 1: Some description."
  - "Subtask 2: Some description."

demo:Link or links to demos of the project.

demo: 
  -
    link: http://demo.com
    description: "This is a description for a demo."
  -
    name: "Demo name"
    link: http://demo.com
    description: "This is a description for a demo with name."

datasets: All the datasets used and created during the paper. This tool supports to define each dataset manually specifying all fields or to use a DOI and ya2ro will try to automatically fetch the data.

datasets:
  - 
    doi_dataset: www.doiDB1.com
  - 
    link: www.D1.com 
    name: "Dataset 1"
    description: "Description dataset 1"
    license: "MIT-License"
    author: "Author name"

software: All the relevant software used and created for the paper. If a GitHub Repo is provided, ya2ro will use SOMEF to automatically fetch relevant data.

software:
  -
    link: https://github.com/KnowledgeCaptureAndDiscovery/somef/
  - 
    link: http://software_1.com 
    name: "Software 1"
    description: "Description software 1"
    license: "MIT-License"

bibliography:In this field is where the bibliography can be added.

bibliography:
  - "Bibliography entry 1"
  - "Bibliography entry 2"
  - "Bibliography entry 3"

authors:In this field is where credit to the creators, collaborators, authors, etc is given. If an ORCID is privided ya2ro will fetch relevant data automatically. If a photo is not provided, a default one will be used.

participatns:
    -
      orcid: https://orcid.org/0000-0003-0454-7145
      role: "Coordinator"
    -
      name: "Author"
      position: "Author's position"
      description: "Author's description"
      web: https://author-web.com/
      photo: "author_photo.jpg"

contact:In this field you can add some contact information.

contact:
  email: [e-mail]
  phone: [phone]