You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ All of the standard setting organizations will collect the predictive and progno
22
22
23
23
Versions supported:
24
24
25
-
- 1.1 (released April 2018)
25
+
- 1.2 (released May 2018)
26
26
27
27
### TNM
28
28
@@ -36,7 +36,7 @@ For diagnosis years 2016-2017, SEER Summary Stage 2000 is required. SEER Summary
36
36
37
37
Versions supported:
38
38
39
-
- 1.7 (released April 2018)
39
+
- 1.8 (released May 2018)
40
40
41
41
### Collaborative Staging
42
42
@@ -50,15 +50,15 @@ Versions supported:
50
50
51
51
## Download
52
52
53
-
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).
53
+
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).
54
54
55
55
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/).
56
56
57
57
## Requirements
58
58
59
59
Functional Requirements: You will need the .NET Framework 4.5.2 or higher installed to use this library.
60
60
61
-
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.
61
+
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.
62
62
63
63
## Usage
64
64
@@ -69,12 +69,30 @@ More detailed documentation can be found in the [Wiki](https://github.com/imsweb
69
69
Everything starts with getting an instance of the `Staging` object. There are `DataProvider` objects for each staging algorithm and version. The `Staging`
70
70
object is thread safe and cached so subsequent calls to `Staging.getInstance()` will return the same object.
71
71
72
-
For example, to get an instance of the Collaborative Staging algorithm
72
+
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.
73
+
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.
73
74
75
+
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.
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].
Schemas represent sets of specific staging instructions. Determining the schema to use for staging is based on primary site, histology and sometimes additional
0 commit comments