source: branches/help/GDEHELP/HELP_WRITTEN/import_calc.help

Last change on this file was 19518, checked in by westram, 2 months ago
File size: 3.6 KB
Line 
1Import from calc-sheets
2
3OCCURRENCE
4
5        ARB/File/Import/Import fields from calc-sheet
6
7DESCRIPTION
8
9        Allows to import data from calc-sheets.
10
11        Your data HAS TO contain a column which allows
12        to identify a species in arb, i.e. a column
13        containing a unique identifier (e.g. the arb species id ('name')
14        or the 'acc' field).
15
16        Workflow:
17
18          * export your calc-sheet in
19            * .csv format (comma separated values) or
20            * .tsv format (tab separated values),
21          * select that file at "Import from CSV",
22          * select format type,
23          * select which sheet-column/arb-field combination
24            identifies the target species,
25          * select the match-mode (use '=' to check for equality; see below for details).
26
27        Each execution of this function does import the cells of ONE column
28        from your file. For each step select
29
30          * sheet-column to import and
31          * target-field desired.
32
33        Additional options:
34
35          * how to handle non-matching sheet-rows.
36          * whether to ignore rows where matching cell is empty.
37          * import scope (marked/all).
38          * set marks of modified species.
39          * field type.
40
41MATCHMODE
42
43        The 'match mode' property allows to fine-tune how the target species
44        identification is done.
45
46        The default setting of 'match mode' is '='.
47        It triggers if the cell content in the selected sheet column matches the
48        content of the selected arb field.
49
50        Other supported settings require to define how cell and field shall be
51        analyzed and compared.
52
53        Each of these two possible definitions has to start with the
54        character 'c' or 'f' (referring the target of the definition: 'cell'
55        or 'field'), followed by either
56
57          * an '=', if that target shall be interpreted as single entry,
58          * the character 'w' followed by a separator character, if the target
59            shall be interpreted as list of multiple entries, or
60          * the character 'd' also followed by a separator character.
61            Same as 'w' above, but ignores duplicated
62            entries, instead of aborting with error.
63
64        In the two latter cases, each entry from that list gets compared versus the
65        other definition (i.e. 'column' versus 'field' or vv.).
66        Depending on the other definition, this either
67
68          * compares a single entry with all entries of a list, or
69          * all combinations of all entries of two lists.
70
71        These comparisons are performed for all combinations of table cells and
72        species in the database.
73
74        The import algorithm requires that each species in the database matches
75        at most with one table row.
76        The cells are required to contain unique content in case mode 'c=' is used.
77        If the cells are interpreted as lists of entries (using 'cw' or 'cd'),
78        the comparison succeeds if one of multiple entries does match.
79        Entries occurring in multiple cells can be regarded as "noise" and will be
80        ignored, if mode contains 'cd' instead of 'cw'.
81        If multiple matches occur (i.e. single entries extracted from one species
82        match multiple table rows), the importer aborts with an error.
83
84        Please note that opposed to what has been said in the previous section,
85        the importer allows that multiple species get assigned to the same table row.
86
87        Examples:
88
89          * 'f=cw;'
90          * 'fw;cw/'
91          * 'fw;cd;'
92
93NOTES
94
95        The reverse dataflow is available
96        via LINK{arb_export_nds.hlp}.
Note: See TracBrowser for help on using the repository browser.