dash.parse.vararginFlags

Parse flags from varargin

---

Syntax

flags = dash.parse.vararginFlags(inputs)
flags = dash.parse.vararginFlags(inputs, spacing)
flags = dash.parse.vararginFlags(inputs, spacing, nPrevious, header)

---

Description

flags = dash.parse.vararginFlags(inputs)

Parses a cell vector of flags into a string vector. Throws error if any elements are not flags.

flags = dash.parse.vararginFlags(inputs, spacing)

Parses a cell vector of values with flags beginning on the first element, and spaced with a given spacing.

flags = dash.parse.vararginFlags(inputs, spacing, nPrevious, header)

Customize error messages and IDs.

---

Input Arguments

inputs

inputs

cell vector

The varargin being parsed

spacing

spacing

scalar positive integer

The spacing of flags along varargin

nPrevious

nPrevious

scalar positive integer

The number of inputs before varargin in the calling function. (Ignoring object reference in class methods.

header

header

string scalar

Header for thrown error IDs.

---

Output Arguments

flags

flags

string vector

The ordered list of flags.