From 607be5ea217d14c7ac5686c8443200b98d1d0fac Mon Sep 17 00:00:00 2001 From: Robert Wynne Date: Tue, 18 Oct 2016 13:42:13 -0400 Subject: [PATCH 1/2] Version 2.0 documentation updates --- README.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8145c16..6963206 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,28 @@ # nci-diff-CDISC diff specific for CDISC reports -CDISC Changes Report Generator -============================== +CDISC Changes Report Generator v2.0 +=================================== This program will generate a changes report between two CDISC releases. The releases may span any amount of time. -Requirements ------------- -Git -Apache Ant -Java Developers Kit +Requirements (with install commands for *nix gurus) +--------------------------------------------------- +Git (sudo apt-get install git) + +Apache Ant (sudo apt-get install ant) + +Java Developers Kit (sudo apt-get install openjdk-8-jdk) Building the program -------------------- -Clone the DiffCDISC repository onto your local filesystem using Git. +Download this entire project as a .zip. + +OR + +Clone the DiffCDISC repository onto your local filesystem using Git: C:\> git clone https://github.com/NCIEVS/diff-cdisc.git @@ -49,8 +55,11 @@ Each report is input into the program (newest followed by oldest), followed by a "release date" and then the filename of the output. C:\DiffCDISC\dist>RunChanges "..\docs\SDTM Terminology 2015-09-25.txt" "..\docs\SDTM Terminology 2015-06-26.txt" "9/25/2015" Changes.txt + Initializing diff report... + Getting changes... + Printing changes report... About the program @@ -71,6 +80,7 @@ of an Update, original and new values are reported. - Update CDISC Definition - Update CDISC Extensible List - Update CDISC Submission Value +- Update CDISC Synonym - Update NCI Preferred Term Known issues @@ -79,3 +89,15 @@ Known issues The 'Request Code' column will always be empty as they are stored in the JIRA tracking system. This column is manually populated by EVS before each quarterly release. + +Version 2.0 was implemented in 2015 + +Release notes between 1.0 and 2.0 +--------------------------------- + +1. Initialize the diff program if and only if there are 4 program arguments +2. The "Request Code" column values no longer appear as "unknown" (they are now empty) +3. Reported changes on non-differing Codelists have been removed +4. Report changes on removed Codelists +5. Verbaige updates to "Change Types" ("Add" or "Remove" on "CDISC Synonyms" is now just "Update" for existing codelists.) +6. Improved handling of inputs From 9ed9fdb00b598da1069206ad70db1713b5eb8122 Mon Sep 17 00:00:00 2001 From: Robert Wynne Date: Tue, 18 Oct 2016 13:43:55 -0400 Subject: [PATCH 2/2] Version 2.0 documentation updates --- ReadMe.txt | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/ReadMe.txt b/ReadMe.txt index 5f9aa7f..6577deb 100644 --- a/ReadMe.txt +++ b/ReadMe.txt @@ -1,19 +1,23 @@ -CDISC Changes Report Generator -============================== +CDISC Changes Report Generator v2.0 +=================================== This program will generate a changes report between two CDISC releases. The releases may span any amount of time. -Requirements ------------- -Git -Apache Ant -Java Developers Kit +Requirements (with install commands for *nix gurus) +--------------------------------------------------- +Git (sudo apt-get install git) +Apache Ant (sudo apt-get install ant) +Java Developers Kit (sudo apt-get install openjdk-8-jdk) Building the program -------------------- -Clone the DiffCDISC repository onto your local filesystem using Git. +Download this entire project as a .zip. + +OR + +Clone the DiffCDISC repository onto your local filesystem using Git: C:\> git clone https://github.com/NCIEVS/diff-cdisc.git @@ -68,6 +72,7 @@ of an Update, original and new values are reported. - Update CDISC Definition - Update CDISC Extensible List - Update CDISC Submission Value +- Update CDISC Synonym - Update NCI Preferred Term Known issues @@ -75,4 +80,16 @@ Known issues The 'Request Code' column will always be empty as they are stored in the JIRA tracking system. This column is manually populated by EVS before -each quarterly release. \ No newline at end of file +each quarterly release. + +Version 2.0 was implemented in 2015 + +Release notes between 1.0 and 2.0 +--------------------------------- + +1. Initialize the diff program if and only if there are 4 program arguments +2. The "Request Code" column values no longer appear as "unknown" (they are now empty) +3. Reported changes on non-differing Codelists have been removed +4. Report changes on removed Codelists +5. Verbaige updates to "Change Types" ("Add" or "Remove" on "CDISC Synonyms" is now just "Update" for existing codelists.) +6. Improved handling of inputs