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: docs/converters/vision_converter.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,10 +91,13 @@ An examplery usage can be found in the example notebook as well as in the test c
91
91
92
92
## Optional extra columns
93
93
94
-
When working with Vision Excel exports, some metadata columns (like `GUID` or `StationID`) may not always be present, especially in partial exports.
95
-
The `optional_extra` feature allows you to specify columns that should be included in `extra_info` if present, but won't cause conversion failure if missing.
94
+
When working with Vision Excel exports, some metadata columns (like `GUID` or `StationID`) may not always be present,
95
+
especially in partial exports.
96
+
The `optional_extra` feature allows you to specify columns that should be included in `extra_info` if present,
97
+
but won't cause conversion failure if missing.
96
98
97
99
**Syntax:**
100
+
98
101
```yaml
99
102
grid:
100
103
Transformers:
@@ -112,13 +115,14 @@ grid:
112
115
```
113
116
114
117
**Behavior:**
118
+
115
119
- Required columns (listed directly under `extra`) will cause a KeyError if missing
116
120
- Optional columns (nested under `optional_extra`) are silently skipped if not found
117
121
- If some optional columns are present and others missing, only the present ones are included in `extra_info`
118
122
- This feature is particularly useful for handling different Vision export configurations or versions
119
123
120
124
**Duplicate handling:**
121
-
When a column appears in both the regular `extra` list and within `optional_extra`,
125
+
When a column appears in both the regular `extra` list and within `optional_extra`,
122
126
the regular `extra` entry takes precedence and duplicates are automatically eliminated from `optional_extra`:
123
127
124
128
```yaml
@@ -131,8 +135,10 @@ extra:
131
135
- StationID # Unique optional - processed if present
132
136
```
133
137
134
-
In this example, `ID` will only be processed once (from the regular `extra` list), while `GUID` and `StationID` are processed as optional columns.
135
-
This prevents duplicate data in the resulting `extra_info` and ensures consistent behavior regardless of column ordering.
138
+
In this example, `ID` will only be processed once (from the regular `extra` list),
139
+
while `GUID` and `StationID` are processed as optional columns.
140
+
This prevents duplicate data in the resulting `extra_info`
141
+
and ensures consistent behavior regardless of column ordering.
0 commit comments