ts_ids_core.schema.project module

Model Assay

Bases: IdsElement

An Assay is an analytical measurement procedure that produces a detectable signal, allowing a process to be qualified and quantified.

Show JSON schema

{
   "description": "An Assay is an analytical measurement procedure that produces a detectable signal, allowing a process to be qualified and quantified.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier assigned to an assay.",
         "type": [
            "string",
            "null"
         ]
      },
      "name": {
         "description": "A human-readable name given to the assay.",
         "type": [
            "string",
            "null"
         ]
      },
      "description": {
         "description": "A human-readable description given to the assay",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

• all_abstract_fields_implemented » all fields

field description: Nullable[str]

A human-readable description given to the assay

field id: Nullable[str]

Unique identifier assigned to an assay.

field name: Nullable[str]

A human-readable name given to the assay.

Model Experiment

Bases: IdsElement

An Experiment is a scientific procedure to investigate a specific hypothesis or a research question. The primary and derived scientific data is used to test the hypothesis, or to provide insight into a particular process. An Experimental entry typically contains additional context, such as purpose, materials, method, and conclusions.

Show JSON schema

{
   "description": "An Experiment is a scientific procedure to investigate a specific hypothesis or a research question. The primary and derived scientific data is used to test the hypothesis, or to provide insight into a particular process. An Experimental entry typically contains additional context, such as purpose, materials, method, and conclusions.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier assigned to a specific experiment conducted within a project. Most often generated within an electronic laboratory notebook (ELN).",
         "type": [
            "string",
            "null"
         ]
      },
      "name": {
         "description": "A human-readable name given to the experiment.",
         "type": [
            "string",
            "null"
         ]
      },
      "description": {
         "description": "A human-readable description given to the experiment.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

• all_abstract_fields_implemented » all fields

field description: Nullable[str]

A human-readable description given to the experiment.

field id: Nullable[str]

Unique identifier assigned to a specific experiment conducted within a project. Most often generated within an electronic laboratory notebook (ELN).

field name: Nullable[str]

A human-readable name given to the experiment.

Model Project

Bases: IdsElement

A Project is a scientific or business program or initiative. A Project ID can be used to associate with the entire set of primary and derived scientific data from every experiment performed to advance a particular initiative, such as the development of an assay or a drug product.

Show JSON schema

{
   "description": "A Project is a scientific or business program or initiative. A Project ID can be used to associate with the entire set of primary and derived scientific data from every experiment performed to advance a particular initiative, such as the development of an assay or a drug product.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier assigned to a project.",
         "type": [
            "string",
            "null"
         ]
      },
      "name": {
         "description": "A human-readable name given to the project.",
         "type": [
            "string",
            "null"
         ]
      },
      "description": {
         "description": "A human-readable description given to the project.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

• all_abstract_fields_implemented » all fields

field description: Nullable[str]

A human-readable description given to the project.

field id: Nullable[str]

Unique identifier assigned to a project.

field name: Nullable[str]

A human-readable name given to the project.

Model ProjectAttributes

Bases: IdsElement

A set of fields which uniquely identify and describe a particular initiative and methodologies used to produce the data in a given IDS. These attributes are commonly found in ELN and LIMS applications and allow users to organize data to associate related datasets.

Show JSON schema

{
   "description": "A set of fields which uniquely identify and describe a particular initiative and methodologies used to produce the data in a given IDS. These attributes are commonly found in ELN and LIMS applications and allow users to organize data to associate related datasets.",
   "type": "object",
   "properties": {
      "project": {
         "$ref": "#/definitions/Project",
         "description": "Project metadata."
      },
      "experiment": {
         "$ref": "#/definitions/Experiment",
         "description": "Experiment metadata."
      },
      "assay": {
         "$ref": "#/definitions/Assay",
         "description": "Assay metadata."
      }
   },
   "additionalProperties": false,
   "definitions": {
      "Assay": {
         "additionalProperties": false,
         "description": "An Assay is an analytical measurement procedure that produces a detectable signal, allowing a process to be qualified and quantified.",
         "properties": {
            "id": {
               "description": "Unique identifier assigned to an assay.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "name": {
               "description": "A human-readable name given to the assay.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "description": {
               "description": "A human-readable description given to the assay",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "type": "object"
      },
      "Experiment": {
         "additionalProperties": false,
         "description": "An Experiment is a scientific procedure to investigate a specific hypothesis or a research question. The primary and derived scientific data is used to test the hypothesis, or to provide insight into a particular process. An Experimental entry typically contains additional context, such as purpose, materials, method, and conclusions.",
         "properties": {
            "id": {
               "description": "Unique identifier assigned to a specific experiment conducted within a project. Most often generated within an electronic laboratory notebook (ELN).",
               "type": [
                  "string",
                  "null"
               ]
            },
            "name": {
               "description": "A human-readable name given to the experiment.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "description": {
               "description": "A human-readable description given to the experiment.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "type": "object"
      },
      "Project": {
         "additionalProperties": false,
         "description": "A Project is a scientific or business program or initiative. A Project ID can be used to associate with the entire set of primary and derived scientific data from every experiment performed to advance a particular initiative, such as the development of an assay or a drug product.",
         "properties": {
            "id": {
               "description": "Unique identifier assigned to a project.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "name": {
               "description": "A human-readable name given to the project.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "description": {
               "description": "A human-readable description given to the project.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "type": "object"
      }
   }
}

Validators:

• all_abstract_fields_implemented » all fields

field assay: Assay

Assay metadata.

field experiment: Experiment

Experiment metadata.

field project: Project

Project metadata.