pyegeria 5.4.0.dev3__py3-none-any.whl → 5.4.0.dev5__py3-none-any.whl

md_processing/dr_egeria_outbox/processed-2025-06-22 21:06-dr_egeria_data_designer_1.md

@@ -0,0 +1,134 @@
+# Dr.Egeria - designing data - part 1
+## Introduction
+
+As data professionals, we often need to design data to be collected, processed, and shared with others.
+The Egeria Data Designer module has been designed to support this. Using the features of data designer we can
+define and refine:
+
+* Data Structures - a composition of data fields (and data structures) that we work with as a unit. For instance, in
+a clinical trial, each measurement record we receive will conform to a data structure.
+* Data Fields - the building blocks of data structures - for example, in a clinical trial data structure we might find data fields for health measurements, a time and date when the measurements were made and a patient identifier.
+* Data Classes - data classes contain a set of rules that describe the allowable values of a kind of data. For instance, when we we receive new data, perhaps we expect a clinical trial measurement record, then we will often want to validate that it conforms to our expectations; that the value of each field, conforms to the data class specification.
+Similarly, if we receive some data and aren't sure what it is, we can compare the values we have received with this same set of rules to propose what kind of data it might be.
+
+These are basic building blocks. The following diagram shows how these building blocks come together in a simple example. The ficticious Coco Pharmaceuticals company
+is running a drug trial to measure the effectiveness of their experimental treatment of Teddy Bear Drop Foot. Each hospital participating in the trial provides
+weekly clinical data records. The clinical trial has established the following data specification to exchange this weekly measurement data.
+
+* A data structure named `TBDF-Incoming Weekly Measurement Data` that is composed of:
+* Data Field: Date
+* Data Field: PatientId
+* Data Field: AngleLeft
+* Data Field: AngleRight
+
+* The data field `PatientId` is composed of two sub-fields
+* Data Field: HospitalId
+* Data Field: PatientNumber
+
+Dr.Egeria allows us to easily sketch this out, and then refine the definitions incrementally as we work through the design.
+So lets begin. First we will define the `TBDF-Incoming Weekly Measurement Data` data structure. We will then Don't Create the new data fields.
+
+___
+
+
+# Update Data Structure
+
+## Data Structure Name 
+
+TBDF-Incoming Weekly Measurement Data
+
+## GUID
+fd9380f4-1067-4f7b-bf3f-cb2f3a0e8341
+
+## Qualified Name
+DataStruct::TBDF-Incoming Weekly Measurement Data
+
+## Description
+This describes the weekly measurement data for each patient for the Teddy Bear drop foot clinical trial.
+
+## Data Fields
+
+
+## Data Specification
+
+
+## Namespace
+
+
+## Version Identifier
+
+
+## Extended Properties
+{}
+
+## Additional Properties
+{}
+
+
+## In Data Dictionary
+
+
+
+## In Data Specification
+
+
+
+
+> Note: While not required, it is good practice to end each Dr.Egeria command with a `___` so that a markdown
+> seperator is displayed between commands. It improves the readability.
+
+#  Don't Create Data Field
+## Data Field
+Date
+## Description
+A date of the form YYYY-MM-DD
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+PatientId
+## Description
+Unique identifier of the patient
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+AngleLeft
+## Description
+Angle rotation of the left leg from vertical
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+AngleRight
+## Description
+Angle rotation of the left leg from vertical
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+
+HospitalId
+
+## Description
+Unique identifier for a hospital. Used in forming PatientId.
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+PatientNumber
+## Description
+Unique identifier of the patient within a hospital.
+
+___
+
+
+
+# Provenance
+
+* Results from processing file dr_egeria_data_designer_1.md on 2025-06-22 21:06

md_processing/dr_egeria_outbox/processed-2025-06-22 21:13-dr_egeria_data_designer_1.md

@@ -0,0 +1,133 @@
+# Dr.Egeria - designing data - part 1
+## Introduction
+
+As data professionals, we often need to design data to be collected, processed, and shared with others.
+The Egeria Data Designer module has been designed to support this. Using the features of data designer we can
+define and refine:
+
+* Data Structures - a composition of data fields (and data structures) that we work with as a unit. For instance, in
+a clinical trial, each measurement record we receive will conform to a data structure.
+* Data Fields - the building blocks of data structures - for example, in a clinical trial data structure we might find data fields for health measurements, a time and date when the measurements were made and a patient identifier.
+* Data Classes - data classes contain a set of rules that describe the allowable values of a kind of data. For instance, when we we receive new data, perhaps we expect a clinical trial measurement record, then we will often want to validate that it conforms to our expectations; that the value of each field, conforms to the data class specification.
+Similarly, if we receive some data and aren't sure what it is, we can compare the values we have received with this same set of rules to propose what kind of data it might be.
+
+These are basic building blocks. The following diagram shows how these building blocks come together in a simple example. The ficticious Coco Pharmaceuticals company
+is running a drug trial to measure the effectiveness of their experimental treatment of Teddy Bear Drop Foot. Each hospital participating in the trial provides
+weekly clinical data records. The clinical trial has established the following data specification to exchange this weekly measurement data.
+
+* A data structure named `TBDF-Incoming Weekly Measurement Data` that is composed of:
+* Data Field: Date
+* Data Field: PatientId
+* Data Field: AngleLeft
+* Data Field: AngleRight
+
+* The data field `PatientId` is composed of two sub-fields
+* Data Field: HospitalId
+* Data Field: PatientNumber
+
+Dr.Egeria allows us to easily sketch this out, and then refine the definitions incrementally as we work through the design.
+So lets begin. First we will define the `TBDF-Incoming Weekly Measurement Data` data structure. We will then Don't Create the new data fields.
+
+___
+
+#  Don't Create Data Structure
+## Data Structure Name
+
+TBDF-Incoming Weekly Measurement Data
+
+## Description
+This describes the weekly measurement data for each patient for the Teddy Bear drop foot clinical trial.
+
+> Note: we will continue to refine this definition as we work through the design.
+
+
+
+___
+> Note: While not required, it is good practice to end each Dr.Egeria command with a `___` so that a markdown
+> seperator is displayed between commands. It improves the readability.
+
+#  Don't Create Data Field
+## Data Field
+Date
+## Description
+A date of the form YYYY-MM-DD
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+PatientId
+## Description
+Unique identifier of the patient
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+AngleLeft
+## Description
+Angle rotation of the left leg from vertical
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+AngleRight
+## Description
+Angle rotation of the left leg from vertical
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+
+HospitalId
+
+## Description
+Unique identifier for a hospital. Used in forming PatientId.
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+PatientNumber
+## Description
+Unique identifier of the patient within a hospital.
+
+___
+# REPORTING
+We can also use Dr.Egeria Commands to report on the Data Structures and Data Fields that we just created. Here
+we request a simplified list form of the output.
+___
+
+
+# `Data Structures` with filter: `*`
+
+# Data Structures Table
+
+Data Structures found from the search string: `All`
+
+| Structure Name | Qualified Name | Namespace | Version | Description | 
+|-------------|-------------|-------------|-------------|-------------|
+| TBDF-Incoming Weekly Measurement Data |  [DataStruct::TBDF-Incoming Weekly Measurement Data](#fd9380f4-1067-4f7b-bf3f-cb2f3a0e8341)  |  |  | This describes the weekly measurement data for each patient for the Teddy Bear drop foot clinical trial. | 
+
+
+
+# `Data Fields` with filter: `*`
+
+# Data Fields Table
+
+Data Fields found from the search string: `All`
+
+| Field Name | Qualified Name | Data Type | Description | 
+|-------------|-------------|-------------|-------------|
+| HospitalId |  [DataField::HospitalId](#ff03f93d-ea32-48fd-b58b-b2c373fb2c09)  | string | Unique identifier for a hospital. Used in forming PatientId. | 
+| AngleRight |  [DataField::AngleRight](#9576193d-f5e9-4715-b919-f5541acf643e)  | string | Angle rotation of the left leg from vertical | 
+| PatientNumber |  [DataField::PatientNumber](#e18b6779-abf6-4ad9-b193-cb67d56eafad)  | string | Unique identifier of the patient within a hospital. | 
+| Date |  [DataField::Date](#7e5e2d39-fd27-4340-95cf-84e6cb265bde)  | string | A date of the form YYYY-MM-DD | 
+| AngleLeft |  [DataField::AngleLeft](#91c5007e-6578-4cf2-bf10-e350aa697071)  | string | Angle rotation of the left leg from vertical | 
+| PatientId |  [DataField::PatientId](#6703d7e2-3251-4967-b0d2-a93583860561)  | string | Unique identifier of the patient | 
+
+# Provenance
+
+* Results from processing file dr_egeria_data_designer_1.md on 2025-06-22 21:13

md_processing/dr_egeria_outbox/processed-2025-06-22 21:19-dr_egeria_data_designer_1.md

@@ -0,0 +1,141 @@
+# Dr.Egeria - designing data - part 1
+## Introduction
+
+As data professionals, we often need to design data to be collected, processed, and shared with others.
+The Egeria Data Designer module has been designed to support this. Using the features of data designer we can
+define and refine:
+
+* Data Structures - a composition of data fields (and data structures) that we work with as a unit. For instance, in
+a clinical trial, each measurement record we receive will conform to a data structure.
+* Data Fields - the building blocks of data structures - for example, in a clinical trial data structure we might find data fields for health measurements, a time and date when the measurements were made and a patient identifier.
+* Data Classes - data classes contain a set of rules that describe the allowable values of a kind of data. For instance, when we we receive new data, perhaps we expect a clinical trial measurement record, then we will often want to validate that it conforms to our expectations; that the value of each field, conforms to the data class specification.
+Similarly, if we receive some data and aren't sure what it is, we can compare the values we have received with this same set of rules to propose what kind of data it might be.
+
+These are basic building blocks. The following diagram shows how these building blocks come together in a simple example. The ficticious Coco Pharmaceuticals company
+is running a drug trial to measure the effectiveness of their experimental treatment of Teddy Bear Drop Foot. Each hospital participating in the trial provides
+weekly clinical data records. The clinical trial has established the following data specification to exchange this weekly measurement data.
+
+* A data structure named `TBDF-Incoming Weekly Measurement Data` that is composed of:
+* Data Field: Date
+* Data Field: PatientId
+* Data Field: AngleLeft
+* Data Field: AngleRight
+
+* The data field `PatientId` is composed of two sub-fields
+* Data Field: HospitalId
+* Data Field: PatientNumber
+
+Dr.Egeria allows us to easily sketch this out, and then refine the definitions incrementally as we work through the design.
+So lets begin. First we will define the `TBDF-Incoming Weekly Measurement Data` data structure. We will then Don't Create the new data fields.
+
+___
+
+#  Don't Create Data Structure
+## Data Structure Name
+
+TBDF-Incoming Weekly Measurement Data
+
+## Description
+This describes the weekly measurement data for each patient for the Teddy Bear drop foot clinical trial.
+
+> Note: we will continue to refine this definition as we work through the design.
+
+
+
+___
+> Note: While not required, it is good practice to end each Dr.Egeria command with a `___` so that a markdown
+> seperator is displayed between commands. It improves the readability.
+
+#  Don't Create Data Field
+## Data Field
+Date
+## Description
+A date of the form YYYY-MM-DD
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+PatientId
+## Description
+Unique identifier of the patient
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+AngleLeft
+## Description
+Angle rotation of the left leg from vertical
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+AngleRight
+## Description
+Angle rotation of the left leg from vertical
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+
+HospitalId
+
+## Description
+Unique identifier for a hospital. Used in forming PatientId.
+
+___
+
+#  Don't Create Data Field
+## Data Field Name
+PatientNumber
+## Description
+Unique identifier of the patient within a hospital.
+
+___
+# REPORTING
+We can also use Dr.Egeria Commands to report on the Data Structures and Data Fields that we just created. Here
+we request a simplified list form of the output.
+___
+
+
+# `Data Structures` with filter: `*`
+
+# Data Structures Table
+
+Data Structures found from the search string: `All`
+
+| Structure Name | Qualified Name | Namespace | Version | Description | 
+|-------------|-------------|-------------|-------------|-------------|
+| TBDF-Incoming Weekly Measurement Data |  [DataStruct::TBDF-Incoming Weekly Measurement Data](#fd9380f4-1067-4f7b-bf3f-cb2f3a0e8341)  |  |  | This describes the weekly measurement data for each patient for the Teddy Bear drop foot clinical trial. | 
+
+
+
+# `Data Fields` with filter: `*`
+
+# Data Fields Table
+
+Data Fields found from the search string: `All`
+
+| Field Name | Qualified Name | Data Type | Description | 
+|-------------|-------------|-------------|-------------|
+| HospitalId |  [DataField::HospitalId](#ff03f93d-ea32-48fd-b58b-b2c373fb2c09)  | string | Unique identifier for a hospital. Used in forming PatientId. | 
+| AngleRight |  [DataField::AngleRight](#9576193d-f5e9-4715-b919-f5541acf643e)  | string | Angle rotation of the left leg from vertical | 
+| PatientNumber |  [DataField::PatientNumber](#e18b6779-abf6-4ad9-b193-cb67d56eafad)  | string | Unique identifier of the patient within a hospital. | 
+| Date |  [DataField::Date](#7e5e2d39-fd27-4340-95cf-84e6cb265bde)  | string | A date of the form YYYY-MM-DD | 
+| AngleLeft |  [DataField::AngleLeft](#91c5007e-6578-4cf2-bf10-e350aa697071)  | string | Angle rotation of the left leg from vertical | 
+| PatientId |  [DataField::PatientId](#6703d7e2-3251-4967-b0d2-a93583860561)  | string | Unique identifier of the patient | 
+
+# Building on what we have done
+One of the interesting features of Dr.Egeria, is that we can take the results of processing a Dr.Egeria command as the
+starting point for refining the information we provided. This is convenient, because when we generate the command output,
+we transform the `Create` commands into `Update` commands. We also add some additional information that Egeria derived for us.
+
+## Next Steps
+For our next steps, we will copy the file produced in the first step into a new file called `dr_egeria_data_designer_2.md`
+Please open that file when you are ready to continue.
+# Provenance
+
+* Results from processing file dr_egeria_data_designer_1.md on 2025-06-22 21:19