Closed dusadrian closed 1 month ago
Adrian, Codebook production is totally manual. This is why we don't normally provide access between reviews or publications. Currently the html documentation is generated with a tool and a considerable amount of hand tweeking. Obviously the goal is to get this production process automated. We are doing this first with lifecycle by using COGS. Following 2.6 we will look at what we need to do to make this work for Codebook. Specific tooling for the current "stone knives and bearskins" approach to codebook production at this point seems a waste of time and effort. COGS seems our best hope.
Wendy
On Wed, Jul 17, 2024, 14:53 Adrian Dușa @.***> wrote:
In the public review version of the DDIC 2.6 from Atlassian https://ddi-alliance.atlassian.net/wiki/spaces/DDI4/pages/2848718849/Public+Review+-+Codebook+Version+2.6, among the attributes of the element "fundAg" there were: "personalID" and "typeOfPersonalID" (along with "affiliation", "abbr" and "role").
In this GitHub version, these two attributes were probably renamed to "agentIdentifier" and "typeOfAgentIdentifier" (I could not find a specific commit). Both are missing from the field level documentation html file specific to this element, which (if I am not mistaken) is still on version 2.5
There seems to be a documentation gap between the schema and other files of the standard, which suggests these are updated manually. If so, I believe this can be done automatically, provided a suitable script.
— Reply to this email directly, view it on GitHub https://github.com/ddialliance/ddi-c_2/issues/15, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJT47KRYN7UYRDKWQBNHQTZM3DTTAVCNFSM6AAAAABLBJINJOVHI2DSMVQWIX3LMV43ASLTON2WKOZSGQYTINBUGE4TKNQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>
I see. Don't know what COGS is (Google tells me Cost Of Goods Sold :) but I am confident that an R script is up to the task. If all this information is kept in a relational database (for Codebook, this is perfectly possible), then R can automatically produce all files, including the field level documentation files. I think automating the process should be a priority, given the amount of work you put in. Plus, it will always be perfectly sync-ed across files and there will be less human error involved.
I will keep you in touch with what we are doing in the production automation line. Here is the link to how we are using COGS for lifecycle and there are links to COGS itself on this page. https://github.com/ddialliance/ddimodel
On Wed, Jul 17, 2024 at 3:45 PM Adrian Dușa @.***> wrote:
I see. Don't know what COGS is (Google tells me Cost Of Goods Sold :) but I am confident that an R script is up to the task. If all this information is kept in a relational database (for Codebook, this is perfectly possible), then R can automatically produce all files, including the field level documentation files. I think automating the process should be a priority, given the amount of work you put in. Plus, it will always be perfectly sync-ed across files and there will be less human error involved.
— Reply to this email directly, view it on GitHub https://github.com/ddialliance/ddi-c_2/issues/15#issuecomment-2234249264, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJT47N3HRWUIDMDDR2YBBDZM3JVZAVCNFSM6AAAAABLBJINJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMZUGI2DSMRWGQ . You are receiving this because you commented.Message ID: @.***>
-- Wendy L. Thomas ISRDI [retired] email: @.***
There was an issue filed to change the attribute names from the original suggested in 2.6 for review. I will have to look up the issue number from JIRA.
Merge request #3 (from 4 months ago)
Issues on multiple small updates #3 https://github.com/ddialliance/ddi-c_2/pull/3
DDICODE-88 DDICODE-92 DDICODE-91 DDICODE-537 DDICODE-536 DDICODE-534 DDICODE-99
Issue DDICODE-92 is the issue in question
On Wed, Jul 17, 2024 at 3:45 PM Adrian Dușa @.***> wrote:
I see. Don't know what COGS is (Google tells me Cost Of Goods Sold :) but I am confident that an R script is up to the task. If all this information is kept in a relational database (for Codebook, this is perfectly possible), then R can automatically produce all files, including the field level documentation files. I think automating the process should be a priority, given the amount of work you put in. Plus, it will always be perfectly sync-ed across files and there will be less human error involved.
— Reply to this email directly, view it on GitHub https://github.com/ddialliance/ddi-c_2/issues/15#issuecomment-2234249264, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJT47N3HRWUIDMDDR2YBBDZM3JVZAVCNFSM6AAAAABLBJINJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMZUGI2DSMRWGQ . You are receiving this because you commented.Message ID: @.***>
-- Wendy L. Thomas ISRDI [retired] email: @.***
Corrected examples to reflect revised attribute names agentIdentifier and typeOfAgentIdentifier contact distrbtr metadataAccs origArch othID
Also corrected spelling error in typeOfAccess in documentation of dataAccs metadataAccs
This will be added in next pull request
In the public review version of the DDIC 2.6 from Atlassian, among the attributes of the element "fundAg" there were: "personalID" and "typeOfPersonalID" (along with "affiliation", "abbr" and "role").
In this GitHub version, these two attributes were probably renamed to "agentIdentifier" and "typeOfAgentIdentifier" (I could not find a specific commit). Both are missing from the field level documentation html file specific to this element, which (if I am not mistaken) is still on version 2.5
There seems to be a documentation gap between the schema and other files of the standard, which suggests these are updated manually. If so, I believe this can be done automatically, provided a suitable script.