From 4e54cb15efcb2421cd7b94f7a4c4b4099e523c45 Mon Sep 17 00:00:00 2001 From: Sabine Maennel Date: Mon, 16 Jan 2023 06:11:50 +0100 Subject: [PATCH] docs: add respec specification of output goal of gimie --- docs/examples/renku.ttl | 22 +++ docs/gimie-output-specification.html | 283 +++++++++++++++++++++++++++ 2 files changed, 305 insertions(+) create mode 100644 docs/examples/renku.ttl create mode 100644 docs/gimie-output-specification.html diff --git a/docs/examples/renku.ttl b/docs/examples/renku.ttl new file mode 100644 index 00000000..3f5bbcab --- /dev/null +++ b/docs/examples/renku.ttl @@ -0,0 +1,22 @@ +@prefix codemeta: . +@prefix schema: . + + a schema:SoftwareSourceCode ; + schema:codeRepository "https://github.com/SwissDataScienceCenter/renku" ; + schema:dateCreated "2017-08-21T15:02:23Z" ; + schema:dateModified "2023-01-13T17:12:31Z" ; + schema:description "Renku provides a platform and tools for reproducible and collaborative data analysis." ; + schema:keywords "collaboration", + "datascience", + "knowledge-graph", + "renku", + "reproducibility" ; + schema:license "http://spdx.org/licenses/Apache-2.0" ; + schema:name "renku" ; + schema:producer ; + schema:url "https://renkulab.io" ; + codemeta:issueTracker "https://github.com/SwissDataScienceCenter/renku/issues" . + + a schema:Organization ; + schema:name "Swiss Data Science Center" ; + schema:url "https://www.datascience.ch/" . \ No newline at end of file diff --git a/docs/gimie-output-specification.html b/docs/gimie-output-specification.html new file mode 100644 index 00000000..441475c8 --- /dev/null +++ b/docs/gimie-output-specification.html @@ -0,0 +1,283 @@ + + + + + Gimie Output Specfication + + + + +
+

Metadata Extraction from Code Repository

+

Compare Image Plaza Requirements to [[CODEMETA]]

+
+
+

Draft in the phase of development.

+
+
+

Introduction

+

Metadata Extraction for Code Repositories

+
+
+

Output from Codemetapy +

+

+ + schema:SoftwareSourceCode + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyURIRangeReqLevelCard
codeRepository + schema:codeRepository + + schema:URL + Optional0..n
dateCreated + schema:dateCreated + + schema:DateTime + Optional0..n
dateModified + schema:dateModified + + schema:DateTime + Optional0..n
description + schema:description + + schema:Text + Optional0..n
keywords + schema:keywords + + schema:Text + Optional0..n
license + schema:license + + schema:URL + Optional0..n
name + schema:keywords + + schema:name + Optional0..n
producer + schema:producer + + schema:Organization + Optional0..n
url + schema:url + + schema:URL + Optional0..n
issueTracker + codemeta:issueTracker + + schema:URL + Optional0..n
+ +
+

Property: codeRepository

+ + + + + + + + + + + + + + + +
Property + schema:codeRepository +
Range + schema:URL +
Get +

+ Get from input url if repo url is provided as parameter +

+
+
+
+

Property: dateCreated

+ + + + + + + + + + + + + + + +
Property + schema:dateCreated +
Range + schema:DateTime +
Get +

+ Get from github api or gitlab api. +

+
+
+
+
+

Output from Image Plaza +

+

+ + schema:SoftwareSourceCode + +

+ + + + + + + + + + + + + + + + + + + +
PropertyURIRangeReqLevelCard
CommandInput + renku:command_input + + renku:has_inputs + Optional0..n
+
+
+

+ This is required for specifications that contain normative material. +

+
+ + \ No newline at end of file