Technical Elements Documentation
    Preparing search index...

    Interface DataAnalysis

    Interface representing the main Data Analysis container

    interface DataAnalysis {
        additionalMetadata?: { assumptions?: string[]; limitations?: string[] };
        commonAssumptions?: BaseAssumption[];
        componentGroupings?: ComponentGrouping[];
        created: string;
        data_parameters: DataAnalysisParameter[];
        dataConsistencyChecks?: DataConsistencyCheck[];
        description?: string;
        documentation?: {
            modelUncertainty?: data_analysis.ModelUncertaintyDocumentation;
            peerReview?: data_analysis.PeerReviewDocumentation;
            preOperationalAssumptions?: data_analysis.PreOperationalAssumptionsDocumentation;
            processDocumentation?: DataAnalysisDocumentation;
        };
        exportImportConfig?: DataAnalysisExportImport;
        externalDataSources?: ExternalDataSource[];
        modified: string;
        outlierComponents?: OutlierComponent[];
        owner?: string;
        references?: {
            description: string;
            technicalElementId: string;
            technicalElementType: TechnicalElementTypes;
        }[];
        sensitivityStudies?: SensitivityStudy[];
        status?: "DRAFT"
        | "APPROVED"
        | "REVIEW"
        | "DEPRECATED";
        tags?: string[];
        type: DATA_ANALYSIS;
        validationRules?: ParameterValidationRules;
        version: string;
    }

    Hierarchy

    • TechnicalElement<TechnicalElementTypes.DATA_ANALYSIS>
      • DataAnalysis
    Index

    Properties

    additionalMetadata? commonAssumptions? componentGroupings? created data_parameters dataConsistencyChecks? description? documentation? exportImportConfig? externalDataSources? modified outlierComponents? owner? references? sensitivityStudies? status? tags? type validationRules? version

    Properties

    additionalMetadata?: { assumptions?: string[]; limitations?: string[] }

    Additional metadata specific to Data Analysis

    Type declaration

    • Optionalassumptions?: string[]

      Data analysis specific assumptions

    • Optionallimitations?: string[]

      Data analysis specific limitations

    commonAssumptions?: BaseAssumption[]

    Common assumptions that apply across this technical element Using the standardized BaseAssumption interface

    componentGroupings?: ComponentGrouping[]

    Component groupings for homogeneous populations

    HLR-DA-B

    created: string

    The date the technical element was created

    data_parameters: DataAnalysisParameter[]

    Array of data analysis parameters that are part of this analysis. Each parameter represents a specific data point or measurement being analyzed.

    dataConsistencyChecks?: DataConsistencyCheck[]

    Data consistency checks performed

    DA-C2

    description?: string

    The description of the technical element

    documentation?: {
        modelUncertainty?: data_analysis.ModelUncertaintyDocumentation;
        peerReview?: data_analysis.PeerReviewDocumentation;
        preOperationalAssumptions?: data_analysis.PreOperationalAssumptionsDocumentation;
        processDocumentation?: DataAnalysisDocumentation;
    }

    Detailed documentation of the data analysis process

    Type declaration

    HLR-DA-E

    exportImportConfig?: DataAnalysisExportImport

    Export/import configuration

    externalDataSources?: ExternalDataSource[]

    External data sources used in the analysis

    HLR-DA-C

    modified: string

    The date the technical element was last modified

    outlierComponents?: OutlierComponent[]

    Components identified as outliers and excluded from groupings

    DA-B2

    owner?: string

    The owner of the technical element

    references?: {
        description: string;
        technicalElementId: string;
        technicalElementType: TechnicalElementTypes;
    }[]

    References to other technical elements

    sensitivityStudies?: SensitivityStudy[]

    Sensitivity studies performed as part of this analysis

    status?: "DRAFT" | "APPROVED" | "REVIEW" | "DEPRECATED"

    The status of the technical element

    tags?: string[]

    Tags associated with the technical element

    type: DATA_ANALYSIS

    The type of technical element

    validationRules?: ParameterValidationRules

    Validation rules for parameters

    version: string

    The version of the technical element

    Settings

    Member Visibility

    On This Page

    Properties