Added data provenance to the documentation.

answerdigital · Dec 1, 2023 · 93d8452 · 93d8452
1 parent 29f0dc5
commit 93d8452
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/OmopTransformer/COSD/Demographics/CosdDemographics.cs b/OmopTransformer/COSD/Demographics/CosdDemographics.cs
@@ -2,6 +2,7 @@
 
 namespace OmopTransformer.COSD.Demographics;
 
+[Description("COSD Demographics")]
 [SourceQuery("OmopDemographics.xml")]
 internal class CosdDemographics
 {

diff --git a/OmopTransformer/Documentation/DocumentationRenderer.cs b/OmopTransformer/Documentation/DocumentationRenderer.cs
@@ -109,6 +109,15 @@ private void RenderProperty(Type mapperType, PropertyInfo property, StringBuilde
         if (attributes.Any())
         {
             stringBuilder.AppendLine($"### {property.Name}");
+
+            var sourceType = GetOmopSourceType(mapperType);
+
+            var description = sourceType.GetCustomAttributes(typeof(DescriptionAttribute)).FirstOrDefault();
+
+            if (description != null)
+            {
+                stringBuilder.AppendLine($"#### {((DescriptionAttribute)description).Value}");
+            }
         }
 
         foreach (var attribute in attributes)

diff --git a/transformation-documentation.md b/transformation-documentation.md
@@ -1,7 +1,9 @@
 `Automatically generated documentation`
 
 # Location
+## COSD Demographics
 ### address_1
+#### COSD Demographics
 Value copied from `StreetAddressLine1`
 * `StreetAddressLine1` The first element of the StructuredAddress element, within the Demographics element.
 <details>
@@ -44,6 +46,7 @@ where
 </details>
 
 ### address_2
+#### COSD Demographics
 Value copied from `StreetAddressLine2`
 * `StreetAddressLine2` The second element of the StructuredAddress element, within the Demographics element.
 <details>
@@ -86,6 +89,7 @@ where
 </details>
 
 ### city
+#### COSD Demographics
 Value copied from `StreetAddressLine3`
 * `StreetAddressLine3` The third element of the StructuredAddress element, within the Demographics element.
 <details>
@@ -128,6 +132,7 @@ where
 </details>
 
 ### county
+#### COSD Demographics
 Value copied from `StreetAddressLine4`
 * `StreetAddressLine4` The fourth and final element of the StructuredAddress element, within the Demographics element.
 <details>
@@ -170,6 +175,7 @@ where
 </details>
 
 ### zip
+#### COSD Demographics
 Value copied from `PostcodeOfUsualAddressAtDiagnosis`
 * `PostcodeOfUsualAddressAtDiagnosis` The value of the PostcodeOfUsualAddressAtDiagnosis element within the Demographics element.
 <details>
@@ -212,6 +218,7 @@ where
 </details>
 
 ### location_source_value
+#### COSD Demographics
 Source columns  `StreetAddressLine1`, `StreetAddressLine2`, `StreetAddressLine3`, `StreetAddressLine4`, `PostcodeOfUsualAddressAtDiagnosis`.
 Deliminate text with newlines.
 * `StreetAddressLine1` The first element of the StructuredAddress element, within the Demographics element.