Jump to: navigation, search

Difference between revisions of "Importing Data from Files"

Line 21: Line 21:
 
For information on how to export data, please see the documentation on the CSV Logger View.
 
For information on how to export data, please see the documentation on the CSV Logger View.
  
[[Image:Importscenario1a.jpg|600px]]
+
[[Image:Importscenario1a.jpg|650px]]
  
 
'''Figure 1a: Organizing your data to prepare to import into STEM.'''
 
'''Figure 1a: Organizing your data to prepare to import into STEM.'''
Line 35: Line 35:
 
Table 1
 
Table 1
  
In order to actually import the data into STEM you must create a scenario. The external data will be read by adding a special disease model
+
In order to actually import the data into STEM you must create a scenario. The external data will be read by adding a special disease model called a "ExternalDataSourceDiseaseModel" to your scenario. Follow the instructions for creating a scenario. Your scenario must contain a  model and graph that contains the same set of the regions named in your collection of data files. So if you want to play back data on US counties, you must add all the US counties to your model.
called a "ExternalDataSourceDiseaseModel" to your scenario. Follow the instructions for creating a scenario. Your scenario must contain
+
a  model and graph that contains the same set of the regions named in your collection of data files. So if you want to play back data on US counties,
+
you must add all the US counties to your model.
+
  
  
When you are ready to add the '''ExternalDataSourceDiseaseModel''' to your scenario (under the model node), click on the icon for adding a new disease.
+
When you are ready to add the '''ExternalDataSourceDiseaseModel''' to your scenario (under the model node), click on the icon for adding a new disease. specify your project and give the disease a name. Select  '''ExternalDataSourceDiseaseModel''' as the disease model. You must then tell the  '''ExternalDataSourceDiseaseModel''' the location of your data file(s). You may use the selector buttons to the right of Data Path. A "Select Directory" dialog (figure 1c) will appear allowing you to select either an individual file (if you have data for only one location) or a Directory that contains the collection you wish to play back.
specify your project and give the disease a name. Select  '''ExternalDataSourceDiseaseModel''' as the disease model. You must then tell the  '''ExternalDataSourceDiseaseModel'''
+
the location of your data file(s). You may use the selector buttons to the right of Data Path. A "Select Directory" dialog (figure 1c) will appear allowing you to select either an individual file (if you have data for only one location) or a Directory that contains the collection you wish to play back.
+
  
  
  
Figure 1b
+
[[Image:Importscenario1b.jpg|400px]]
 +
 
 +
'''Figure 1b: Creating an  ExternalDataSourceDiseaseModel.'''
 +
 
 +
[[Image:Importscenario1c.jpg|400px]]
 +
 
 +
'''Figure 1c: Select the Directory that Contains your data.'''
  
Figure 1c
 
  
 
Once you have created a scenario set up to Replay a disease from an external file you can also edit the data path using the Properties Editor.  Just go to your project, find the  ExternalDataSourceDiseaseModel you created
 
Once you have created a scenario set up to Replay a disease from an external file you can also edit the data path using the Properties Editor.  Just go to your project, find the  ExternalDataSourceDiseaseModel you created

Revision as of 18:12, 25 April 2008

Importing Data From External Files

Overview:

STEM also allows users to import data from one or more external files and to play them back. Today, import is supported for Comma Separated Variable (CSV) files.


Organizing the Data Files:

The individual files or collections of files for a particular scenario should be grouped in a single folder. In figure 1a we show a collection of files, all containing Shigella data, grouped in a folder called "ScenarioShigella". This folder can have any name and be placed in any location. In the example below we place the folder in the same location that STEM typically exports data to, namely:

  ... runtime-stem.product\.metadata\.plugins\org.eclipse.ohf.stem.diseasemodels\csv\

Where your runtime-stem.product\ is typically located n C:\runtime-stem.product\ in a default Eclipse installation.

To import data, it is necessary that a CSV file be created for each location. Each file name should be the unique stem ID for the location where the data originates. For example, in Figure 1a we show several files containing data from different locations in Israel, Jordan, and Palestine. The file extension should be .txt or .csv.

For information on how to export data, please see the documentation on the CSV Logger View.

Importscenario1a.jpg

Figure 1a: Organizing your data to prepare to import into STEM.

Each comma separate variable file should contain a header indicating the type of data in each column. The first column should contain a sequential iteration or row number. The Second column should contain the time the data applies to (each row should be sequential in time). The following columns should indicate the total count (individuals) in different states. If the csv file was generated by STEM (i.e. by EXPORTING from a previous run) then there will be one column for every disease state used in the model that generate the data (e.g., S,I,R or S,E,I,R). If the data is from syndromic surveillance users will likely not have information on every possible state but when importing you must have columns and column header for each state you plan to display (for example, SI). Note that the data in each column must be total count (individuals) and not fraction in each state. The numbers may be floating point (allowing fractional people infected for example).


Table 1

In order to actually import the data into STEM you must create a scenario. The external data will be read by adding a special disease model called a "ExternalDataSourceDiseaseModel" to your scenario. Follow the instructions for creating a scenario. Your scenario must contain a model and graph that contains the same set of the regions named in your collection of data files. So if you want to play back data on US counties, you must add all the US counties to your model.


When you are ready to add the ExternalDataSourceDiseaseModel to your scenario (under the model node), click on the icon for adding a new disease. specify your project and give the disease a name. Select ExternalDataSourceDiseaseModel as the disease model. You must then tell the ExternalDataSourceDiseaseModel the location of your data file(s). You may use the selector buttons to the right of Data Path. A "Select Directory" dialog (figure 1c) will appear allowing you to select either an individual file (if you have data for only one location) or a Directory that contains the collection you wish to play back.


Importscenario1b.jpg

Figure 1b: Creating an ExternalDataSourceDiseaseModel.

Importscenario1c.jpg

Figure 1c: Select the Directory that Contains your data.


Once you have created a scenario set up to Replay a disease from an external file you can also edit the data path using the Properties Editor. Just go to your project, find the ExternalDataSourceDiseaseModel you created under the "decorators" folder, and double click on it in the Resource Set window (See figure 2). The Editor will show up allowing you to change this path used to read in data.

Figure 2


Once you have completed setting up your scenario, Save your work at this point by hitting ctrl-s To replay your data, simply select the scenario you created in the STEM project explorer, right click, and select run. STEM will launch, load the locations you specified and play back your data.