User Tools

Site Tools


howtos:importing_informant_definitions_-_sets_and_categories

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
howtos:importing_informant_definitions_-_sets_and_categories [2010/09/16 15:59]
marcus.williams
howtos:importing_informant_definitions_-_sets_and_categories [2024/03/14 10:21] (current)
Line 1: Line 1:
-[Found this stuff in the create() tool documentation. We can trim as required]+**Found this stuff in the create() tool documentation. We can trim as required.** 
 + 
 +List the ways set informants can be defined: 
 +  * manually in Documenter 
 +  * copy-and-paste from one Documenter .dmm file to another 
 +  * from an informant definition file within Documenter (set or category) 
 +    * sets definition files can be created from the source data with a TOOL script 
 + 
 +Sequence informants are defined in the Documenter dialogue box.
  
 ====== Creating a Set Object ====== ====== Creating a Set Object ======
Line 135: Line 143:
 corn corn seed crop corn corn seed crop
 barley barley seed crop} barley barley seed crop}
-===== +=====
 Specifying an Object Description ===== Specifying an Object Description =====
  
Line 155: Line 163:
  
 The statement creates a set object with a description of "​gender":​ The statement creates a set object with a description of "​gender":​
 +
 ===== Element names - characters to avoid ===== ===== Element names - characters to avoid =====
  
Line 161: Line 170:
 It is highly reccomended that whitespace and other non-alphanumeric characters be avoided in element names. It is highly reccomended that whitespace and other non-alphanumeric characters be avoided in element names.
  
-[Describe the searchElemName and replaceElemName parameters in the create ​tool. Provide examples.] FIXME+Here is an example: 
 + 
 +<​code>​ 
 +localinformant employmentSector_d[] = create ​(; object=set, delimiter=",",​ \ 
 +        allowDuplicate=off,​ \ 
 +        elemNamesFromColNum=1,​ firstLine=1,​ \ 
 +        searchElemName1=",",​ replaceElemName1="",​ \ 
 +        searchElemName2="​.", replaceElemName2="​_",​ \ 
 +        searchElemName3="&",​ replaceElemName3="​and",​ \ 
 +        searchElemName4="/",​ replaceElemName4="​_",​ \ 
 +        searchElemName5="​(",​ replaceElemName5="",​ \ 
 +        searchElemName6="​)",​ replaceElemName6="",​ \ 
 +        searchElemName7="​]", replaceElemName7="",​ \ 
 +        searchElemName8="​[",​ replaceElemName8="",​ \ 
 +        searchElemName9="​-",​ replaceElemName9="​_",​ \ 
 +        searchElemName10="'",​ replaceElemName10="",​ \ 
 +        searchElemName11="​$",​ replaceElemName11="​dlr",​ \ 
 +        searchElemName12="​%",​ replaceElemName12="​pct",​ \ 
 +        searchElemName13=":",​ replaceElemName13="",​ \ 
 +        stripLeadingWhiteSpace=off,​ \ 
 +        replaceWhiteSpaceInElemName="​_"​ , \ 
 +        file=$fileName) 
 +</​code>​ 
 + 
 +====== Creating a Category Object ====== 
 + 
 +===== Specifying the Category Definition from Parameters ===== 
 + 
 +Example: 
 + 
 +<​code>​ 
 +localinformant egtCOfte_nr[] = create (; object=category,​ \ 
 +        desc="​elecGenTech category of fuelTypeElec",​ \ 
 +        groups = elecGenTech,​ \ 
 +        members = fuelTypeElec,​ \ 
 +        delimiter = ",",​ \ 
 +        "​combSteamSF"​ = "​coal,​heavyOil,​petroleumCoke,​naturalGas",​ \ 
 +        "​combTurbineSF"​ = "​coal,​heavyOil,​petroleumCoke,​naturalGas",​ \ 
 +        "​combineCycleSF"​ = "​coal,​heavyOil,​petroleumCoke,​naturalGas",​ \ 
 +        "​nucLWSteam"​ = "​urainium",​ \ 
 +        "​nucHWSteam"​ = "​urainium",​ \ 
 +        "​combSteamMF"​ = "​multiFuel",​ \ 
 +        "​combTurbineMF"​ = "​multiFuel",​ \ 
 +        "​combineCycleMF"​ = "​multiFuel",​ \ 
 +        "​industrialSector"​ = "​nonSpecifiedFuel",​ \ 
 +        "​commercialSector"​ = "​nonSpecifiedFuel"​) 
 +</​code>​ 
howtos/importing_informant_definitions_-_sets_and_categories.1284652766.txt.gz · Last modified: 2010/09/16 15:59 by marcus.williams