Skip to content

Commit

Permalink
Updates to schema files based on IEEE 2791-202 publication.
Browse files Browse the repository at this point in the history
 `https://opensource.ieee.org/2791-object/ieee-2791-schema/-/releases/version-1.4`
Changes to be committed:
	modified:   ieee-2791-schema/2791object.json
	modified:   ieee-2791-schema/AUTHORS
	modified:   ieee-2791-schema/CONTRIBUTORS
	modified:   ieee-2791-schema/LICENSE
	modified:   ieee-2791-schema/README.md
	modified:   ieee-2791-schema/description_domain.json
	modified:   ieee-2791-schema/error_domain.json
	modified:   ieee-2791-schema/execution_domain.json
	modified:   ieee-2791-schema/io_domain.json
	modified:   ieee-2791-schema/parametric_domain.json
	modified:   ieee-2791-schema/provenance_domain.json
	modified:   ieee-2791-schema/usability_domain.json
  • Loading branch information
HadleyKing committed May 19, 2020
1 parent ec4070c commit be65ecb
Show file tree
Hide file tree
Showing 12 changed files with 52 additions and 32 deletions.
4 changes: 2 additions & 2 deletions ieee-2791-schema/2791object.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/2791object.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/2791object.json",
"type": "object",
"title": "Base type for all IEEE-2791 Objects",
"description": "All IEEE-2791 object types must adhear to this type in order to be compliant with IEEE-2791 standard",
Expand Down Expand Up @@ -121,7 +121,7 @@
"type": "string",
"description": "Version of the IEEE-2791 specification used to define this document",
"examples": [
"https://w3id.org/2791/"
"https://w3id.org/ieee/ieee-2791-schema/"
],
"readOnly": true,
"format": "uri"
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/AUTHORS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This is the list of IEEE-2791 Object Schema authors for copyright purposes.
# IEEE 2791 Object Schema Authors
#
# This does not necessarily list everyone who has contributed code,
# since in some cases, their employer may be the copyright holder.
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This is the list of IEEE-2791 Object Schema contributors
# This is the list of IEEE 2791 Object Schema contributors
#
# This does not necessarily list the copyright holders, since in some
# cases, an employer may be the copyright holder. To see the full
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2019 The IEEE-2791 Object Schema Authors
Copyright 2020 IEEE 2791 Object Schema Authors

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
Expand Down
60 changes: 40 additions & 20 deletions ieee-2791-schema/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,51 @@
# IEEE-2791 Object Schema
# IEEE 2791 Object Schema

IEEE 2791 Object Schema is intended for use as part of IEEE 2791 Std.,
*Standard for Bioinformatics Computations and Analyses Generated by
High-Throughput Sequencing (HTS) to Facilitate Communication.*

IEEE Std 2791™-2020 normatively references Version 1.4 of ieee-2791-schema.


IEEE-2791 (previously known as "BioCompute") Object Schema is a project of the
IEEE P2791 BioCompute Working Group intended for use as part of IEEE P2791
(Standard for Bioinformatics Computations and Analyses Generated by
High-Throughput Sequencing (HTS) to Facilitate Communication).

## License

All source files (.json files) in this repository are subject to the
following copyright and licensing terms.

Copyright 2019 The IEEE-2791 Schema Authors.
> Copyright 2020 IEEE 2791 Object Schema Authors
>
> Redistribution and use in source and binary forms, with or without
> modification, are permitted provided that the following conditions are
> met:
>
> * Redistributions of source code must retain the above copyright
> notice, this list of conditions and the following disclaimer.
>
> * Redistributions in binary form must reproduce the above copyright
> notice, this list of conditions and the following disclaimer in the
> documentation and/or other materials provided with the distribution.
>
> * Neither the name of the copyright holder nor the names of its
> contributors may be used to endorse or promote products derived from
> this software without specific prior written permission.
>
> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
> "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
> A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
> HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
> SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
> LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
> DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
> THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
> (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
> OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
>
> SPDX-License-Identifier: BSD-3-Clause


See the LICENSE file distributed with this work for copyright and
licensing information, the AUTHORS file for a list of copyright
holders, and the CONTRIBUTORS file for the list of contributors.

## Disclaimer

This open source repository contains material that may be included-in
or referenced by an unapproved draft of a proposed IEEE Standard. All
material in this repository is subject to change. The material in this
repository is presented "as is" and with all faults. Use of the
material is at the sole risk of the user. IEEE specifically disclaims
all warranties and representations with respect to all material
contained in this repository and shall not be liable, under any
theory, for any use of the material. Unapproved drafts of proposed
IEEE standards must not be utilized for any conformance/compliance
purposes.

2 changes: 1 addition & 1 deletion ieee-2791-schema/description_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/description_domain.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/description_domain.json",
"type": "object",
"title": "Description Domain",
"description": "Structured field for description of external references, the pipeline steps, and the relationship of I/O objects.",
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/error_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/error_domain.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/error_domain.json",
"type": "object",
"title": "Error Domain",
"description": "Fields in the Error Domain are open-ended and not restricted nor defined by the IEEE-2791 standard. It is RECOMMENDED that the keys directly under empirical_error and algorithmic_error use a full URI. Resolving the URI SHOULD give a JSON Schema or textual definition of the field. Other keys are not allowed error_domain",
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/execution_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/execution_domain.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/execution_domain.json",
"type": "object",
"title": "Execution Domain",
"description": "The fields required for execution of the IEEE-2791 Object are herein encapsulated together in order to clearly separate information needed for deployment, software configuration, and running applications in a dependent environment",
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/io_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/io_domain.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/io_domain.json",
"type": "object",
"title": "Input and Output Domain",
"description": "The list of global input and output files created by the computational workflow, excluding the intermediate files. Custom to every specific IEEE-2791 Object implementation, these fields are pointers to objects that can reside in the system performing the computation or any other accessible system.",
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/parametric_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/parametric_domain",
"$id": "https://w3id.org/ieee/ieee-2791-schema/parametric_domain.json",
"type": "array",
"title": "Parametric Domain",
"description": "This represents the list of NON-default parameters customizing the computational flow which can affect the output of the calculations. These fields can be custom to each kind of analysis and are tied to a particular pipeline implementation",
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/provenance_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/provenance_domain.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/provenance_domain.json",
"type": "object",
"title": "Provenance Domain",
"description": "Structured field for tracking data through transformations, including contributors, reviewers, and versioning.",
Expand Down
2 changes: 1 addition & 1 deletion ieee-2791-schema/usability_domain.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://w3id.org/2791/usability_domain.json",
"$id": "https://w3id.org/ieee/ieee-2791-schema/usability_domain.json",
"type": "array",
"title": "Usability Domain",
"description": "Author-defined usability domain of the IEEE-2791 Object. This field is to aid in search-ability and provide a specific description of the function of the object.",
Expand Down

0 comments on commit be65ecb

Please sign in to comment.