Skip to content

Commit 16553b6

Browse files
committed
Updated version number and Readme.md.
1 parent 4870d32 commit 16553b6

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ All of the standard setting organizations will collect the predictive and progno
2222

2323
Versions supported:
2424

25-
- 1.1 (released April 2018)
25+
- 1.2 (released May 2018)
2626

2727
### TNM
2828

@@ -36,7 +36,7 @@ For diagnosis years 2016-2017, SEER Summary Stage 2000 is required. SEER Summary
3636

3737
Versions supported:
3838

39-
- 1.7 (released April 2018)
39+
- 1.8 (released May 2018)
4040

4141
### Collaborative Staging
4242

@@ -50,15 +50,15 @@ Versions supported:
5050

5151
## Download
5252

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).
5454

5555
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/).
5656

5757
## Requirements
5858

5959
Functional Requirements: You will need the .NET Framework 4.5.2 or higher installed to use this library.
6060

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.
6262

6363
## Usage
6464

@@ -69,12 +69,30 @@ More detailed documentation can be found in the [Wiki](https://github.com/imsweb
6969
Everything starts with getting an instance of the `Staging` object. There are `DataProvider` objects for each staging algorithm and version. The `Staging`
7070
object is thread safe and cached so subsequent calls to `Staging.getInstance()` will return the same object.
7171

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.
7374

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.
7476
```csharp
75-
TNMStagingCSharp.Src.Staging.Staging staging = TNMStagingCSharp.Src.Staging.Staging.getInstance(CsDataProvider.getInstance(CsVersion.v020550));
77+
using System.IO;
78+
using TNMStagingCSharp.Src.Staging;
79+
80+
TNMStagingCSharp.Src.Staging.Staging _STAGING;
81+
FileStream SourceStream = File.Open("CS_02_05_50.zip", FileMode.Open);
82+
ExternalStagingFileDataProvider provider = new ExternalStagingFileDataProvider(SourceStream);
83+
84+
_STAGING = TNMStagingCSharp.Src.Staging.Staging.getInstance(provider);
7685
```
7786

87+
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].
88+
```csharp
89+
using TNMStagingCSharp.Src.Staging.CS;
90+
91+
TNMStagingCSharp.Src.Staging.Staging _STAGING;
92+
_STAGING = TNMStagingCSharp.Src.Staging.Staging.getInstance(CsDataProvider.getInstance(CsVersion.v020550));
93+
```
94+
95+
7896
### Schemas
7997

8098
Schemas represent sets of specific staging instructions. Determining the schema to use for staging is based on primary site, histology and sometimes additional

TNMStagingCSharp/TNMStagingCSharp/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@
3232
// You can specify all the values or you can default the Build and Revision Numbers
3333
// by using the '*' as shown below:
3434
// [assembly: AssemblyVersion("1.0.*")]
35-
[assembly: AssemblyVersion("1.8.0.0")]
36-
[assembly: AssemblyFileVersion("1.8.0.0")]
35+
[assembly: AssemblyVersion("2.0.0.0")]
36+
[assembly: AssemblyFileVersion("2.0.0.0")]

0 commit comments

Comments
 (0)