Skip to content

Class: Timepoint

One occasion on which data were collected, and where it sits relative to the intervention. Declared once on StudyDesign.timepoints and referenced by identifier; FactorLevel.timepoints is the only slot that references one, so it is the whole of how an occasion reaches a model.

A study that compared occasions did so with a ModelTerm whose levels name them, paradigm or no paradigm. An occasion no level references was collected but never modelled: legitimate where the record only describes when follow-up happened, a defect where the analyses report change over time, which validate_record.py flags. Names stay in the source's wording; what is normalized is where an occasion sits and in what order.

URI: neurostudy:Timepoint

 classDiagram
    class Timepoint
    click Timepoint href "../Timepoint/"
      Timepoint : id

      Timepoint : name

      Timepoint : order

      Timepoint : relation_to_intervention

      Timepoint : time_from_intervention

Slots

Name Cardinality and Range Description Inheritance
id 1
String
direct
name 1
String
Short occasion label as the source states it, for example baseline, post-trea... direct
relation_to_intervention 1
String or 
TimepointRelation
Where this occasion sits relative to the intervention direct
order 0..1
Integer
Position of this occasion in the study's sequence, counting from 1 direct
time_from_intervention 0..1
String
Elapsed time between the intervention and this occasion, in the source's own ... direct

Usages

used by used in type used
StudyDesign timepoints range Timepoint
FactorLevel timepoints range Timepoint

Identifier and Mapping Information

Schema Source

  • from schema: https://neurostuff.org/schemas/neuroimaging-study-storage

Mappings

Mapping Type Mapped Value
self neurostudy:Timepoint
native neurostudy:Timepoint

LinkML Source

Direct

name: Timepoint
description: 'One occasion on which data were collected, and where it sits relative
  to the intervention. Declared once on `StudyDesign.timepoints` and referenced by
  identifier; `FactorLevel.timepoints` is the only slot that references one, so it
  is the whole of how an occasion reaches a model.

  A study that *compared* occasions did so with a `ModelTerm` whose levels name them,
  paradigm or no paradigm. An occasion no level references was collected but never
  modelled: legitimate where the record only describes when follow-up happened, a
  defect where the analyses report change over time, which `validate_record.py` flags.
  Names stay in the source''s wording; what is normalized is where an occasion sits
  and in what order.'
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage
rank: 1000
attributes:
  id:
    name: id
    in_subset:
    - mvp
    - deterministic
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    identifier: true
    domain_of:
    - Arm
    - Timepoint
    - Group
    - Task
    - Condition
    - Assessment
    - Region
    - Acquisition
    - Device
    - Analysis
    - Measure
    - Preprocessing
    - ModelEstimation
    - ModelTerm
    - InferenceSettings
    - StatisticalMap
    - Table
    - CoordinateSet
    - Study
    range: string
    required: true
  name:
    name: name
    description: Short occasion label as the source states it, for example baseline,
      post-treatment, six-month follow-up.
    in_subset:
    - mvp
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    domain_of:
    - Arm
    - Timepoint
    - Group
    - Task
    - Condition
    - Assessment
    - Region
    - Analysis
    - ModelTerm
    - ExternalDataset
    - PerformanceMetric
    range: string
    required: true
  relation_to_intervention:
    name: relation_to_intervention
    description: 'Where this occasion sits relative to the intervention. Required,
      so an occasion the source does not place still carries the slot, as `extraction_status:
      not_reported`.'
    in_subset:
    - mvp
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    rank: 1000
    domain_of:
    - Timepoint
    required: true
    any_of:
    - range: TimepointRelation
    - range: string
  order:
    name: order
    description: Position of this occasion in the study's sequence, counting from
      1. Carries the ordering that `relation_to_intervention` cannot when several
      occasions share a relation -- the earliest `post_intervention` occasion is the
      study's endpoint, later ones are follow-ups.
    in_subset:
    - mvp
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    rank: 1000
    domain_of:
    - Timepoint
    - FactorLevel
    range: integer
    minimum_value: 1
  time_from_intervention:
    name: time_from_intervention
    description: Elapsed time between the intervention and this occasion, in the source's
      own words and units, for example 24 h or six weeks.
    in_subset:
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    rank: 1000
    domain_of:
    - Timepoint
    range: string

Induced

name: Timepoint
description: 'One occasion on which data were collected, and where it sits relative
  to the intervention. Declared once on `StudyDesign.timepoints` and referenced by
  identifier; `FactorLevel.timepoints` is the only slot that references one, so it
  is the whole of how an occasion reaches a model.

  A study that *compared* occasions did so with a `ModelTerm` whose levels name them,
  paradigm or no paradigm. An occasion no level references was collected but never
  modelled: legitimate where the record only describes when follow-up happened, a
  defect where the analyses report change over time, which `validate_record.py` flags.
  Names stay in the source''s wording; what is normalized is where an occasion sits
  and in what order.'
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage
rank: 1000
attributes:
  id:
    name: id
    in_subset:
    - mvp
    - deterministic
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    identifier: true
    owner: Timepoint
    domain_of:
    - Arm
    - Timepoint
    - Group
    - Task
    - Condition
    - Assessment
    - Region
    - Acquisition
    - Device
    - Analysis
    - Measure
    - Preprocessing
    - ModelEstimation
    - ModelTerm
    - InferenceSettings
    - StatisticalMap
    - Table
    - CoordinateSet
    - Study
    range: string
    required: true
  name:
    name: name
    description: Short occasion label as the source states it, for example baseline,
      post-treatment, six-month follow-up.
    in_subset:
    - mvp
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    owner: Timepoint
    domain_of:
    - Arm
    - Timepoint
    - Group
    - Task
    - Condition
    - Assessment
    - Region
    - Analysis
    - ModelTerm
    - ExternalDataset
    - PerformanceMetric
    range: string
    required: true
  relation_to_intervention:
    name: relation_to_intervention
    description: 'Where this occasion sits relative to the intervention. Required,
      so an occasion the source does not place still carries the slot, as `extraction_status:
      not_reported`.'
    in_subset:
    - mvp
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    rank: 1000
    owner: Timepoint
    domain_of:
    - Timepoint
    range: string
    required: true
    any_of:
    - range: TimepointRelation
    - range: string
  order:
    name: order
    description: Position of this occasion in the study's sequence, counting from
      1. Carries the ordering that `relation_to_intervention` cannot when several
      occasions share a relation -- the earliest `post_intervention` occasion is the
      study's endpoint, later ones are follow-ups.
    in_subset:
    - mvp
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    rank: 1000
    owner: Timepoint
    domain_of:
    - Timepoint
    - FactorLevel
    range: integer
    minimum_value: 1
  time_from_intervention:
    name: time_from_intervention
    description: Elapsed time between the intervention and this occasion, in the source's
      own words and units, for example 24 h or six weeks.
    in_subset:
    - model_extracted
    from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/design
    rank: 1000
    owner: Timepoint
    domain_of:
    - Timepoint
    range: string