Merge pull request #3 from imsweb/Version20

Version20

Author: halla-ims

README.md

@@ -22,7 +22,7 @@ All of the standard setting organizations will collect the predictive and progno
 
 Versions supported:
 
-- 1.1 (released April 2018)
+- 1.2 (released May 2018)
 
 ### TNM
 
@@ -36,7 +36,7 @@ For diagnosis years 2016-2017, SEER Summary Stage 2000 is required. SEER Summary
 
 Versions supported:
 
-- 1.7 (released April 2018)
+- 1.8 (released May 2018)
 
 ### Collaborative Staging
 
@@ -50,15 +50,15 @@ Versions supported:
 
 ## Download
 
-To download [the beta version of staging library - TNMStagingCSharp_v17.zip](https://github.com/imsweb/staging-client-csharp/releases/download/v1.7-beta/TNMStagingCSharp_v17.zip).
+To download [the beta version of staging library - TNMStagingCSharp_v20.zip](https://github.com/imsweb/staging-client-csharp/releases/download/v2.0-beta/TNMStagingCSharp_v20.zip).
 
 The download zip file contains the TNM Staging DLL and associated files. For more information, please reference the accompanying readme.txt file. Detailed documentation on how to use the DLL can be found in the [Wiki](https://github.com/imsweb/staging-client-csharp/wiki/).
 
 ## Requirements
 
 Functional Requirements: You will need the .NET Framework 4.5.2 or higher installed to use this library. 
 
-Data Requirements: You will need the algorithm data files for the TNM Staging Library to work properly. At present there are CS 02.05.50, TNM 1.5, and EOD 1.1 algorithms. You can find a copy of these data files within the TNM Staging source code in the Resources\Algorithms directory. The algorithm data files can be either in separate JSON files, or can be collected together in a compressed file such as .ZIP or .GZ. You can download the zip versions of [CS 02.05.50](https://github.com/imsweb/staging-client-csharp/releases/download/v1.8-beta/CS_02_05_50.zip), [TNM 1.7](https://github.com/imsweb/staging-client-csharp/releases/download/v1.8-beta/TNM_17.zip), and [EOD Public 1.1](https://github.com/imsweb/staging-client-csharp/releases/download/v1.8-beta/EOD_Public_11.zip) here. 
+Data Requirements: You will need the algorithm data files for the TNM Staging Library to work properly. At present there are CS 02.05.50, TNM 1.8, and EOD 1.2 algorithms. You can find a copy of these data files within the TNM Staging source code in the Resources\Algorithms directory. The algorithm data files can be either in separate JSON files, or can be collected together in a compressed file such as .ZIP or .GZ. You can download the zip versions of [CS 02.05.50](https://github.com/imsweb/staging-client-csharp/releases/download/v2.0-beta/CS_02_05_50.zip), [TNM 1.8](https://github.com/imsweb/staging-client-csharp/releases/download/v2.0-beta/TNM_18.zip), and [EOD Public 1.2](https://github.com/imsweb/staging-client-csharp/releases/download/v2.0-beta/EOD_Public_12.zip) here. 
 
 ## Usage
 
@@ -69,12 +69,30 @@ More detailed documentation can be found in the [Wiki](https://github.com/imsweb
 Everything starts with getting an instance of the `Staging` object.  There are `DataProvider` objects for each staging algorithm and version.  The `Staging`
 object is thread safe and cached so subsequent calls to `Staging.getInstance()` will return the same object.
 
-For example, to get an instance of the Collaborative Staging algorithm
+To use a DataProvider, you will need a copy of a staging algorithm with the staging library. Each algorithm is composed of a collection of JSON files which represent the schemas and tables of that algorithm. These algorithm files can either be separate JSON files and in a directory on your hard drive, or they can be in a single zip file. 
+The staging library contains 3 algorithms in the Resources sub directory. Included with the release of the staging library, we also include zip versions of the algorithms. We recommend using the zip versions as they are easier to maintain and replace with newer versions. 
 
+For example, to use the Collaborative Stage algorithm (in a single zip file), use the ExternalStagingFileDataProvider class. This option allows you to use a single zip file containing the entire CS algorithm.
 ```csharp
-TNMStagingCSharp.Src.Staging.Staging staging = TNMStagingCSharp.Src.Staging.Staging.getInstance(CsDataProvider.getInstance(CsVersion.v020550));
+using System.IO;
+using TNMStagingCSharp.Src.Staging;
+
+TNMStagingCSharp.Src.Staging.Staging _STAGING;
+FileStream SourceStream = File.Open("CS_02_05_50.zip", FileMode.Open);
+ExternalStagingFileDataProvider provider = new ExternalStagingFileDataProvider(SourceStream);
+
+_STAGING = TNMStagingCSharp.Src.Staging.Staging.getInstance(provider);
 ```
 
+To use the Collaborative Stage algorithm (in separate JSON files), use the CsDataProvider class. This option requires that you have the Algorithm files (JSON) in a directory named Algorithms \ CS \ [Version Number].
+```csharp
+using TNMStagingCSharp.Src.Staging.CS;
+
+TNMStagingCSharp.Src.Staging.Staging _STAGING;
+_STAGING = TNMStagingCSharp.Src.Staging.Staging.getInstance(CsDataProvider.getInstance(CsVersion.v020550));
+```
+
+
 ### Schemas
 
 Schemas represent sets of specific staging instructions.  Determining the schema to use for staging is based on primary site, histology and sometimes additional

TNMStagingCSharp/Resources/Algorithms/TNM/1.7/schemas/heme_retic.json

@@ -1,10 +1,10 @@
 {
   "id" : "adnexa_uterine_other",
   "algorithm" : "tnm",
-  "version" : "1.7",
+  "version" : "1.8",
   "name" : "Adnexa Uterine Other",
   "title" : "Broad and Round Ligaments, Parametrium, Uterine Adnexa",
-  "notes" : "C571  Broad ligament\nC572  Round ligament\nC573  Parametrium\nC574  Uterine adnexa\n\n**Note:** TNM is not defined for this schema. If directly assigning Summary Stage 2000 (SS2000), use the *Broad and Round Ligaments, Parametrium, Uterine Adnexa* chapter on page 218 of the [SS2000 on-line manual](http://seer.cancer.gov/tools/ssm/SSSM2000-122012.pdf#page=218).",
+  "notes" : "C571  Broad ligament\nC572  Round ligament\nC573  Parametrium\nC574  Uterine adnexa\n\n**Note:** TNM is not defined for this schema. If directly assigning Summary Stage 2000 (SS2000), use the *Broad and Round Ligaments, Parametrium, Uterine Adnexa* chapter on page 218 of the [SS2000 on-line manual](https://seer.cancer.gov/tools/ssm/ssm2000/SSSM2000-122012.pdf#page=218).",
   "schema_selection_table" : "schema_selection_adnexa_uterine_other",
   "inputs" : [ {
     "key" : "year_dx",
@@ -74,5 +74,5 @@
   } ],
   "involved_tables" : [ "primary_site", "histology", "schema_selection_adnexa_uterine_other", "year_dx_validation" ],
   "on_invalid_input" : "FAIL_WHEN_USED_FOR_STAGING",
-  "last_modified" : "2018-04-11T19:53:09.038Z"
+  "last_modified" : "2018-05-08T17:39:15.353Z"
 }

…NM/1.7/schemas/adnexa_uterine_other.json …NM/1.8/schemas/adnexa_uterine_other.jsonTNMStagingCSharp/Resources/Algorithms/TNM/1.7/schemas/adnexa_uterine_other.json renamed to TNMStagingCSharp/Resources/Algorithms/TNM/1.8/schemas/adnexa_uterine_other.json TNMStagingCSharp/Resources/Algorithms/TNM/1.7/schemas/adnexa_uterine_other.json renamed to TNMStagingCSharp/Resources/Algorithms/TNM/1.8/schemas/adnexa_uterine_other.json

@@ -1,10 +1,10 @@
 {
   "id" : "adrenal_gland",
   "algorithm" : "tnm",
-  "version" : "1.7",
+  "version" : "1.8",
   "name" : "Adrenal Gland",
   "title" : "Adrenal Gland",
-  "notes" : "C740  Cortex of adrenal gland\nC741  Medulla of adrenal gland\nC749  Adrenal gland, NOS\n\n**Note 1:** This schema is based on the UICC chapter *Adrenal Cortex Tumours* pages 270-272.\n* Primary sites C741 and C749 are not listed in this chapter of the UICC manual; however, they are included in this schema and TNM staged if appropriate histology criteria are met\n\n**Note 2:**  Laterality must be coded for this site.\n\n**Note 3:** In addition to directly assigning TNM, Summary Stage 2000 (SS2000) must be captured.  If directly assigning SS2000, use the *Thymus, Adrenal (Suprarenal) Gland and Other Endocrine Glands* chapter on page 278 of the [SS2000 on-line manual](http://seer.cancer.gov/tools/ssm/SSSM2000-122012.pdf#page=278).",
+  "notes" : "C740  Cortex of adrenal gland\nC741  Medulla of adrenal gland\nC749  Adrenal gland, NOS\n\n**Note 1:** This schema is based on the UICC chapter *Adrenal Cortex Tumours* pages 270-272.\n* Primary sites C741 and C749 are not listed in this chapter of the UICC manual; however, they are included in this schema and TNM staged if appropriate histology criteria are met\n\n**Note 2:**  Laterality must be coded for this site.\n\n**Note 3:** In addition to directly assigning TNM, Summary Stage 2000 (SS2000) must be captured.  If directly assigning SS2000, use the *Thymus, Adrenal (Suprarenal) Gland and Other Endocrine Glands* chapter on page 278 of the [SS2000 on-line manual](https://seer.cancer.gov/tools/ssm/ssm2000/SSSM2000-122012.pdf#page=278).",
   "schema_selection_table" : "schema_selection_adrenal_gland",
   "inputs" : [ {
     "key" : "year_dx",
@@ -600,5 +600,5 @@
   } ],
   "involved_tables" : [ "determine_default_t", "adrenal_m_7434", "radiation_surg_seq", "tnm7_path_stage_uba", "determine_default_m", "nodes_pos_fpa", "parse_t_2177", "concatenate_n_43246", "tnm7_stage_uba", "ssf2_kak", "stage_group_p_44348", "parse_n_67182", "determine_default_n", "stage_group_94596", "histology", "concatenate_m_40642", "adrenal_gland_t_18187", "combined_t_no_tis", "concatenate_t_51262", "ssf3_laf", "path_n_adrenal_gland_53740", "adjustments_for_no_clin_or_no_path_26261", "schema_selection_adrenal_gland", "determine_combined_prefix_91402", "path_t_adrenal_gland_28077", "stop_if_no_clin_and_no_path_24035", "systemic_surg_seq", "parse_m_47057", "primary_site", "combined_m", "combined_n", "year_dx_validation", "tnm7_inclusions_tqc", "path_m_hbv", "adrenal_gland_n_44698" ],
   "on_invalid_input" : "FAIL_WHEN_USED_FOR_STAGING",
-  "last_modified" : "2018-04-11T19:53:09.433Z"
+  "last_modified" : "2018-05-08T17:39:29.730Z"
 }

…ithms/TNM/1.7/schemas/adrenal_gland.json …ithms/TNM/1.8/schemas/adrenal_gland.jsonTNMStagingCSharp/Resources/Algorithms/TNM/1.7/schemas/adrenal_gland.json renamed to TNMStagingCSharp/Resources/Algorithms/TNM/1.8/schemas/adrenal_gland.json TNMStagingCSharp/Resources/Algorithms/TNM/1.7/schemas/adrenal_gland.json renamed to TNMStagingCSharp/Resources/Algorithms/TNM/1.8/schemas/adrenal_gland.json

@@ -1,10 +1,10 @@
 {
   "id" : "ampulla_vater",
   "algorithm" : "tnm",
-  "version" : "1.7",
+  "version" : "1.8",
   "name" : "Ampulla Vater",
   "title" : "Ampulla of Vater (excluding Neuroendocrine Tumor)",
-  "notes" : "C241  Ampulla of Vater\n\n**Note 1:** This schema is based on the UICC chapter *Ampulla of Vater,* pages 129-131.\n\n**Note 2:** In addition to directly assigning TNM, Summary Stage 2000 (SS2000) must be captured.  If directly assigning SS2000, use the *Ampulla of Vater* chapter on page 114 of the [SS2000 on-line manual](http://seer.cancer.gov/tools/ssm/SSSM2000-122012.pdf#page=114).",
+  "notes" : "C241  Ampulla of Vater\n\n**Note 1:** This schema is based on the UICC chapter *Ampulla of Vater,* pages 129-131.\n\n**Note 2:** In addition to directly assigning TNM, Summary Stage 2000 (SS2000) must be captured.  If directly assigning SS2000, use the *Ampulla of Vater* chapter on page 114 of the [SS2000 on-line manual](https://seer.cancer.gov/tools/ssm/ssm2000/SSSM2000-122012.pdf#page=114).",
   "schema_selection_table" : "schema_selection_ampulla_vater",
   "inputs" : [ {
     "key" : "year_dx",
@@ -613,5 +613,5 @@
   } ],
   "involved_tables" : [ "clin_m_har", "determine_default_t", "path_m_har", "ssf2_kpc", "radiation_surg_seq", "determine_default_m", "ssf1_jpe", "nodes_pos_fpa", "parse_t_2177", "concatenate_n_43246", "parse_n_67182", "ampulla_of_vater_t_63892", "determine_default_n", "ssf3_lpc", "histology", "concatenate_m_40642", "behavior", "tnm7_inclusions_tpe", "concatenate_t_51262", "clin_n_ampulla_vater_45064", "adjustments_for_no_clin_or_no_path_26261", "stage_group_p_45729", "tnm7_path_stage_uaa", "determine_combined_prefix_91402", "stage_group_c_22295", "schema_selection_ampulla_vater", "stop_if_no_clin_and_no_path_24035", "systemic_surg_seq", "tnm7_stage_uaa", "combined_n_for_tis_cancers_4947", "parse_m_47057", "path_t_ampulla_vater_23469", "primary_site", "path_n_dbo", "combined_m", "year_dx_validation", "combined_t" ],
   "on_invalid_input" : "FAIL_WHEN_USED_FOR_STAGING",
-  "last_modified" : "2018-04-11T19:53:09.361Z"
+  "last_modified" : "2018-05-08T17:39:27.155Z"
 }