Skip to content

Class: ReportingProtocol

Protocol or plan for reporting and dissemination.

URI: revaise:ReportingProtocol

```mermaid classDiagram class ReportingProtocol click ReportingProtocol href "../ReportingProtocol/" StageProtocol <|-- ReportingProtocol click StageProtocol href "../StageProtocol/"

  ReportingProtocol : base_protocol_date

  ReportingProtocol : base_protocol_description

  ReportingProtocol : base_protocol_deviations

  ReportingProtocol : base_protocol_id

  ReportingProtocol : base_protocol_notes

  ReportingProtocol : base_protocol_software





    ReportingProtocol --> "*" ExternalTool : base_protocol_software
    click ExternalTool href "../ExternalTool/"



  ReportingProtocol : base_protocol_tools





    ReportingProtocol --> "*" ExternalTool : base_protocol_tools
    click ExternalTool href "../ExternalTool/"



  ReportingProtocol : base_protocol_training





    ReportingProtocol --> "0..1" StageTrainingInfo : base_protocol_training
    click StageTrainingInfo href "../StageTrainingInfo/"



  ReportingProtocol : base_protocol_version

  ReportingProtocol : data_availability_plan

  ReportingProtocol : open_access_plan

  ReportingProtocol : planned_reporting_standards

  ReportingProtocol : preprint_plan

  ReportingProtocol : reporting_timeline

  ReportingProtocol : target_audiences

  ReportingProtocol : target_publication_types





    ReportingProtocol --> "*" ReportDocumentType : target_publication_types
    click ReportDocumentType href "../ReportDocumentType/"

```

Inheritance

Slots

Name Cardinality and Range Description Inheritance
target_audiences *
String
Intended audiences for the report direct
target_publication_types *
ReportDocumentType
Planned publication or dissemination types direct
reporting_timeline 0..1
String
Timeline or schedule for reporting direct
planned_reporting_standards *
String
Reporting standards planned for use direct
open_access_plan 0..1
String
Open access plan for reports or manuscripts direct
data_availability_plan 0..1
String
Plan for data availability statements and shared data direct
preprint_plan 0..1
String
Plan for preprint posting direct
base_protocol_id 1
String
Unique identifier for this stage protocol StageProtocol
base_protocol_version 0..1
String
Version of the protocol StageProtocol
base_protocol_date 0..1
Date
Date the protocol was finalized StageProtocol
base_protocol_description 0..1
String
Detailed description of the protocol StageProtocol
base_protocol_tools *
ExternalTool
Tools used in this stage StageProtocol
base_protocol_software *
ExternalTool
Software packages used in this stage StageProtocol
base_protocol_deviations *
String
Deviations from the planned protocol StageProtocol
base_protocol_notes 0..1
String
Additional notes about the protocol StageProtocol
base_protocol_training 0..1
StageTrainingInfo
Training provided for this stage StageProtocol

Usages

used by used in type used
ReportingStage reporting_protocol range ReportingProtocol

Identifier and Mapping Information

Schema Source

  • from schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting

Mappings

Mapping Type Mapped Value
self revaise:ReportingProtocol
native revaise:ReportingProtocol

LinkML Source

Direct

name: ReportingProtocol
description: Protocol or plan for reporting and dissemination.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
is_a: StageProtocol
slots:
- target_audiences
- target_publication_types
- reporting_timeline
- planned_reporting_standards
- open_access_plan
- data_availability_plan
- preprint_plan
slot_usage:
  target_audiences:
    name: target_audiences
    multivalued: true
  target_publication_types:
    name: target_publication_types
    multivalued: true
  planned_reporting_standards:
    name: planned_reporting_standards
    multivalued: true

Induced

name: ReportingProtocol
description: Protocol or plan for reporting and dissemination.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
is_a: StageProtocol
slot_usage:
  target_audiences:
    name: target_audiences
    multivalued: true
  target_publication_types:
    name: target_publication_types
    multivalued: true
  planned_reporting_standards:
    name: planned_reporting_standards
    multivalued: true
attributes:
  target_audiences:
    name: target_audiences
    description: Intended audiences for the report
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: string
    multivalued: true
  target_publication_types:
    name: target_publication_types
    description: Planned publication or dissemination types
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: ReportDocumentType
    multivalued: true
  reporting_timeline:
    name: reporting_timeline
    description: Timeline or schedule for reporting
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: string
  planned_reporting_standards:
    name: planned_reporting_standards
    description: Reporting standards planned for use
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: string
    multivalued: true
  open_access_plan:
    name: open_access_plan
    description: Open access plan for reports or manuscripts
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: string
  data_availability_plan:
    name: data_availability_plan
    description: Plan for data availability statements and shared data
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: string
  preprint_plan:
    name: preprint_plan
    description: Plan for preprint posting
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - ReportingProtocol
    range: string
  base_protocol_id:
    name: base_protocol_id
    description: Unique identifier for this stage protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    identifier: true
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: string
    required: true
  base_protocol_version:
    name: base_protocol_version
    description: Version of the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: string
  base_protocol_date:
    name: base_protocol_date
    description: Date the protocol was finalized
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: date
  base_protocol_description:
    name: base_protocol_description
    description: Detailed description of the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: string
  base_protocol_tools:
    name: base_protocol_tools
    description: Tools used in this stage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: ExternalTool
    multivalued: true
  base_protocol_software:
    name: base_protocol_software
    description: Software packages used in this stage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: ExternalTool
    multivalued: true
  base_protocol_deviations:
    name: base_protocol_deviations
    description: Deviations from the planned protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: string
    multivalued: true
  base_protocol_notes:
    name: base_protocol_notes
    description: Additional notes about the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: string
  base_protocol_training:
    name: base_protocol_training
    description: Training provided for this stage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/reporting
    rank: 1000
    owner: ReportingProtocol
    domain_of:
    - StageProtocol
    range: StageTrainingInfo