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.
classDiagram
class Timepoint
click Timepoint href "../Timepoint/"
Timepoint : local_id
Timepoint : name
Timepoint --> "1" ExtractedString : name
click ExtractedString href "../ExtractedString/"
Timepoint : order
Timepoint --> "0..1" ExtractedInteger : order
click ExtractedInteger href "../ExtractedInteger/"
Timepoint : relation_to_intervention
Timepoint --> "1" ExtractedTimepointRelation : relation_to_intervention
click ExtractedTimepointRelation href "../ExtractedTimepointRelation/"
Timepoint : stable_id
Timepoint : time_from_intervention
Timepoint --> "0..1" ExtractedString : time_from_intervention
click ExtractedString href "../ExtractedString/"
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| stable_id | 0..1 String |
UUID minted by the store the first time this entity appears, never by an extr... | direct |
| local_id | 1 String |
direct | |
| name | 1 ExtractedString |
Short occasion label as the source states it, for example baseline, post-trea... | direct |
| relation_to_intervention | 1 ExtractedTimepointRelation |
Where this occasion sits relative to the intervention | direct |
| order | 0..1 ExtractedInteger |
Position of this occasion in the study's sequence, counting from 1 | direct |
| time_from_intervention | 0..1 ExtractedString |
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-extraction
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | neurostudy_ex:Timepoint |
| native | neurostudy_ex: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-extraction
rank: 1000
attributes:
stable_id:
name: stable_id
description: UUID minted by the store the first time this entity appears, never
by an extractor, and kept across re-runs so a later extraction matches the same
entity.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Acquisition
- Device
- Analysis
- Measure
- Preprocessing
- ModelEstimation
- ModelTerm
- InferenceSettings
- Table
- CoordinateSet
- Study
range: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
local_id:
name: local_id
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
identifier: true
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Acquisition
- Device
- Analysis
- Measure
- Preprocessing
- ModelEstimation
- ModelTerm
- InferenceSettings
- 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.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Analysis
- ModelTerm
- ExternalDataset
- PerformanceMetric
range: ExtractedString
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`.'
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
rank: 1000
domain_of:
- Timepoint
range: ExtractedTimepointRelation
required: true
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.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
rank: 1000
domain_of:
- Timepoint
- FactorLevel
range: ExtractedInteger
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.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
rank: 1000
domain_of:
- Timepoint
range: ExtractedString
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-extraction
rank: 1000
attributes:
stable_id:
name: stable_id
description: UUID minted by the store the first time this entity appears, never
by an extractor, and kept across re-runs so a later extraction matches the same
entity.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
owner: Timepoint
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Acquisition
- Device
- Analysis
- Measure
- Preprocessing
- ModelEstimation
- ModelTerm
- InferenceSettings
- Table
- CoordinateSet
- Study
range: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
local_id:
name: local_id
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
identifier: true
owner: Timepoint
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Acquisition
- Device
- Analysis
- Measure
- Preprocessing
- ModelEstimation
- ModelTerm
- InferenceSettings
- 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.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
owner: Timepoint
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Analysis
- ModelTerm
- ExternalDataset
- PerformanceMetric
range: ExtractedString
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`.'
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
rank: 1000
owner: Timepoint
domain_of:
- Timepoint
range: ExtractedTimepointRelation
required: true
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.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
rank: 1000
owner: Timepoint
domain_of:
- Timepoint
- FactorLevel
range: ExtractedInteger
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.
from_schema: https://neurostuff.org/schemas/neuroimaging-study-extraction/design
rank: 1000
owner: Timepoint
domain_of:
- Timepoint
range: ExtractedString