databank.merge
(+databank)
Merge two or more databanks
Syntax
outputDb = databank.merge(method, primaryDb [, otherDb ], ___)
Shortcut syntax for databank.merge("horzcat", ___)
outputDb = databank.horzcat(primaryDb, [, otherDb], ___)
Input arguments
method
[ "horzcat"
| "vertcat"
| "replace"
| "warning"
| "discard"
| "error"
]
Action to perform when two or more of the input mergeWith contain a field of the same name; see Description.
primaryDb
[ struct | Dictionary ]
Primary input databank that will be merged with the other input mergeWith,
d1
, etc. using themethod
.
otherDb
[ struct | Dictionary ]
One or more mergeWith which will be merged with the primaryinput databank
primaryDb
to create theoutputDb
.
Output arguments
outputDb
[ struct | Dictionary ]
Output databank created by merging the input mergeWith using the method specified by the
method
.
Options
MissingField=@rmfield
[ @rmfield
| NaN
| [ ]
| * ]
Action to take when a field is missing from one or more of the input mergeWith when the
method
is"horzcat"
.
WhenFailed="warning"
[ "warning"
| "silent"
| "error"
]
Action to take when the
method
fails to merge a field across some of the input databanks.WhenFailed="warning"
orWhenFailed="silent"
results in the failed fields being excluded from theoutputDb
.
Description
The fields from each of the additional mergeWith (d1
and further) are
added to the main databank d
. If the name of a field to be added
already exists in the main databank, d
, one of the following actions is
performed:
-
"horzcat"
- horizontally concatenate the fields; -
"replace"
- silently replace the field in the main databank with the new field; -
"warning"
- replace the field in the main databank with the new field, and throw a warning; -
"discard"
- keep the field in the main databank unchanged, and discard the new field; -
"error"
- throw an error whenever the main databank and the other databank contain a field of the same name.