Main Content

getvaropts

Get variable import options

collapse all in page

Syntax

varOpts = getvaropts(opts,selection)

Description

example

varOpts= getvaropts(opts,selection)returns the variable import options for the variables specified inselection.

Examples

collapse all

Open Live Script

Access the variable import options object that controls the importing of a variable using thegetvaroptsfunction.

Create import options from a file. The options object is a collection of individual variable import options.

opts = detectImportOptions('patients.xls')
opts = SpreadsheetImportOptions with properties: Sheet Properties: Sheet: '' Replacement Properties: MissingRule: 'fill' ImportErrorRule: 'fill' Variable Import Properties: Set types by name using setvartype VariableNames: {'LastName', 'Gender', 'Age' ... and 7 more} VariableTypes: {'char', 'char', 'double' ... and 7 more} SelectedVariableNames: {'LastName', 'Gender', 'Age' ... and 7 more} VariableOptions: Show all 10 VariableOptions Access VariableOptions sub-properties using setvaropts/getvaropts VariableNamingRule: 'modify' Range Properties: DataRange: 'A2' (Start Cell) VariableNamesRange: 'A1' RowNamesRange: '' VariableUnitsRange: '' VariableDescriptionsRange: '' To display a preview of the table, use preview

Get the variable import options object for the specified variable.

varOpts = getvaropts(opts,'Systolic')
varOpts = NumericVariableImportOptions with properties: Variable Properties: Name: 'Systolic' Type: 'double' FillValue: NaN TreatAsMissing: {} QuoteRule: 'remove' Prefixes: {} Suffixes: {} EmptyFieldRule: 'missing' Numeric Options: ExponentCharacter: 'eEdD' DecimalSeparator: '.' ThousandsSeparator: '' TrimNonNumeric: 0 NumberSystem: 'decimal'

To modify the variable import options, see thesetvaroptsandsetvartypefunction reference pages.

Input Arguments

collapse all

File import options, specified as aSpreadsheetImportOptions,DelimitedTextImportOptions, or aFixedWidthImportOptionsobject created by thedetectImportOptionsfunction. Theoptsobject contains properties that control the data import process, such as variable properties, data location properties, replacement rules, and others.

选择变量,指定为a character vector, string scalar, cell array of character vectors, string array, array of numeric indices, or a logical array.

Variable names (or indices) must be a subset of the names contained in theVariableNamesproperty of theoptsobject.

Example:'Height'

Example:{'Height','LastName'}

Example:[5 9]

Data Types:char|string|cell|uint64

Output Arguments

collapse all

Type dependent options for selected variables, returned as an array of variable import options objects. The array contains an object corresponding to each variable specified in theselectionargument. Depending on the data types of the variables, each object in the array is one of these types: numeric, text,logical,datetime, andcategorical.

You can modify properties of the individual objects.

  • To modify theTypeproperty, use thesetvartypefunction.

  • To modify other properties, use thesetvaroptsfunction.

Version History

Introduced in R2016b

See Also

|||