pyegeria 5.4.0.15__py3-none-any.whl → 5.4.0.17__py3-none-any.whl

md_processing/dr_egeria_inbox/data_test3.md

@@ -0,0 +1,462 @@
+
+___
+
+
+#   Update Glossary
+## Glossary Name
+Test Glossary
+## Description
+This glossary is just for testing
+
+___
+
+#   Update Term
+## In Glossary
+Test Glossary
+## Term Name
+Hospital Identifier
+## Description
+Identifies each hospital uniquely. Used within the PatientId field.
+
+___
+
+#  Update Data Dictionary
+## Name
+Clinical Trial Data Dictionary
+
+## Description
+A data dictionary for clinical trial data elements.
+
+
+#    Update Data Dictionary
+## Name
+Pharma Data Dictionary
+
+## Description
+A data dictionary of elements relevant to the Pharma communities.
+
+
+___
+
+#    Update Data Spec
+
+## Data Specification 
+
+Data Specification for the Teddy Bear Drop Clinical Trial
+
+## Description
+Principle data requirements for Teddy Bear Drop Clinical Trial. Meow
+
+## Qualified Name
+DataSpec::Data Specification for the Teddy Bear Drop Clinical Trial
+
+## Classifications
+
+## Guid
+
+
+___
+
+
+#    Update Data Specification
+
+## Data Specification Name 
+
+Test Spec2
+
+## Description
+A test spec - Meow
+
+## Qualified Name
+
+## Classifications
+
+## Guid
+
+## Additional Properties
+{
+    "a prop" : "meow",
+    "another" : "woof"
+}
+___
+
+#  Update Data Dictionary
+
+## Dictionary Name 
+
+dw
+
+## Description
+A data dictionary for dan..meow
+## Qualified Name
+DataDict::dw
+
+## Classifications
+
+## GUID
+
+
+___
+
+
+#   Update Data Structure
+
+## Data Structure Name 
+
+TBDF-Incoming Weekly Measurement Data
+
+## Description
+This describes the weekly measurement data for each patient for the Teddy Bear dropt clinical trial. 
+
+## Qualified Name
+DataStruct::TBDF-Incoming Weekly Measurement Data
+
+## Namespace
+
+## In Data Specification
+Data Specification for the Teddy Bear Drop Clinical Trial
+
+## Version Identifier
+
+
+## Guid
+
+
+___
+
+#    Update Data Structure
+
+## Data Structure Name 
+
+WWT-Incoming Weekly Measurement Data
+
+## Description
+A collection of data fields that form a data structure.
+
+## Qualified Name
+DataStruct::WWT-Incoming Weekly Measurement Data
+
+## In Data Specification
+Test Spec2
+
+## Namespace
+
+
+## Version Identifier
+
+
+## GUID
+
+
+
+___
+
+#   Update Data Field
+
+## Data Field Name 
+
+PatientId
+
+## Description
+Unique identifier of the patient
+
+## Qualified Name
+DataField::PatientId
+
+
+## Data Type
+
+String
+
+## Guid
+
+## Data Class
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary, Pharma Data Dictionary
+
+## In Data Structure
+TBDF-Incoming Weekly Measurement Data
+DataStruct::WWT-Incoming Weekly Measurement Data
+
+## Glossary Term
+GlossaryTerm::ClinicalTrialTerminology::PatientId
+___
+
+
+
+#   Update Data Field
+
+## Data Field Name
+
+HospitalId
+
+## Description
+Unique identifier for a hospital. Used in forming PatientId.
+
+## Qualified Name
+DataField::HospitalId
+
+## Data Type
+String
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+## In Data Structure
+
+DataStruct::TBDF-Incoming Weekly Measurement Data
+DataStruct::WWT-Incoming Weekly Measurement Data
+
+## Position
+1
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## Glossary Term
+Term::Hospital Identifier
+
+## Parent Data Field
+DataField::PatientId
+
+## Journal Entry
+Just creating this term
+
+___
+
+#   Update Data Field
+
+## Data Field Name 
+
+PatientSN
+
+## Description
+Unique identifier of the patient within a hospital.
+
+## Qualified Name
+DataField::PatientSN
+
+
+## Data Type
+
+String
+## Position
+2
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+## In Data Structure
+DataStruct::TBDF-Incoming Weekly Measurement Data
+DataStruct::WWT-Incoming Weekly Measurement Data
+
+## Parent Data Field
+DataField::PatientId
+
+## Journal Entry
+Just creating this term
+
+___
+
+#    Update Data Class
+
+## Data Class Name 
+
+Date
+
+## Description
+A date of the form YYYY-MM-DD
+
+## Qualified Name
+DataClass::Date
+
+## Data Type
+date
+## Position
+0
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+
+## Containing Data Class
+
+## Specializes Data Class
+
+## Journal Entry
+Just creating this date
+
+
+
+___
+
+#     Update Data Class
+
+## Data Class Name 
+
+ISO-Date
+
+## Description
+ISO 8601 standard date. A date of the form YYYY-MM-DD
+
+## Qualified Name
+DataClass::ISO-Date
+
+## Data Type
+date
+## Position
+0
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+
+## Containing Data Class
+
+## Specializes Data Class
+DataClass::Date
+## Journal Entry
+Just creating this date
+
+
+___
+
+
+#   Update Data Field
+
+## Data Field 
+
+Date
+
+## Description
+A date of the form YYYY-MM-DD
+
+## Qualified Name
+DataField::Date
+
+
+## Data Type
+date
+
+## Position
+0
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+## In Data Structure
+TBDF-Incoming Weekly Measurement Data,
+DataStruct::WWT-Incoming Weekly Measurement Data
+
+## Parent Data Field
+
+## Data Class
+DataClass::ISO-Date
+
+## Journal Entry
+Just creating this date
+
+
+___
+
+
+
+#  Update Data Class
+
+## Data Class Name 
+
+Address
+
+## Description
+Address Class
+
+## Qualified Name
+
+
+
+## Data Type
+
+String
+## Position
+0
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+
+## Containing Data Class
+
+## Specializes Data Class
+
+## Journal Entry
+Just creating this date
+
+
+
+# Update Data Class
+
+## Data Class Name 
+
+Street Address
+
+## Description
+Street Address including number and name of street.
+
+## Qualified Name
+
+
+
+## Data Type
+
+String
+## Position
+0
+
+## Min Cardinality
+0
+
+## Max Cardinality
+1
+
+## In Data Dictionary
+DataDict::Clinical Trial Data Dictionary
+
+
+## Containing Data Class
+DataClass::Address
+## Specializes Data Class
+

md_processing/dr_egeria_inbox/dr_egeria_data_designer_1.md

@@ -0,0 +1,124 @@
+# 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.
+
+___
+
+# Update Data Field
+## Data Field Name
+PatientNumber
+## Description
+Unique identifier of the patient within a hospital. More information
+
+___
+___
+# 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.
+___
+
+# Don't View Data Structures
+## Output Format
+LIST
+___
+
+# View Data Fields
+## Output Format
+LIST
+## AsOfTime
+2025-06-24
+___
+___
+# 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.