spreadsheetImportOptions — Create spreadsheet import options structs for readtable.
opts = spreadsheetImportOptions(...) returns an editable import-options struct accepted by readtable for spreadsheet files. The struct supports MATLAB-style dot assignment before import, including data ranges, sheet selection, variable names, and variable types.
Syntax
opts = spreadsheetImportOptions()
opts = spreadsheetImportOptions(nameValuePairs...)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
nameValuePairs | Any | Variadic | — | Name-value option pairs. |
Returns
| Name | Type | Description |
|---|---|---|
opts | Any | Spreadsheet import options struct. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:table:InvalidArgument | Arguments or table metadata are invalid. | table: invalid argument |
RunMat:table:InvalidIndex | Table indexing is invalid. | table: invalid index |
RunMat:table:InvalidVariable | A table variable name or value is invalid. | table: invalid variable |
RunMat:readtable:IOError | readtable cannot open or read the requested file. | readtable: file read failed |
RunMat:readtable:UnsupportedFileType | readtable receives a file type outside the text or spreadsheet import backends. | readtable: unsupported file type |
How spreadsheetImportOptions works
- Accepts name-value options including
'NumVariables','VariableNames','VariableTypes','DataRange','Range','Sheet','ReadVariableNames','ReadRowNames','TreatAsMissing','VariableNamingRule','TextType','DatetimeType', and'EmptyLineRule'. 'NumVariables'creates defaultVar1,Var2, ... names andautovariable types; editedVariableNamesandVariableTypesare validated against that count.DataRangeis treated as the spreadsheet cell range forreadtable, matching the common MATLAB workflowopts.DataRange = 'C2:C37'.VariableTypesentries guide import coercion for double, single, all eight native integer classes, logical, string, char, cellstr, datetime, and duration columns. Integer text is parsed directly into authoritative storage, including exact 64-bit values.- A typed-integer
NumVariablesis accepted as the documented positive scalar integer and must fit the host index domain. Typed integers used for other location controls are a RunMat-only extension and are rejected in MATLAB compatibility mode before metadata construction. - Default options do not force a zero-column import;
readtableinfers the column count unless a positiveNumVariablesis supplied. - Invalid option names, malformed ranges, unsupported sheets, and unparseable typed values raise descriptive
readtableerrors instead of silently changing the schema.
GPU memory and residency
No GPU work is performed. Options are host metadata, and later readtable imports create host table variables.
Examples
Import A Spreadsheet Column With An Options Struct
opts = spreadsheetImportOptions('NumVariables', 1);
opts.DataRange = 'C2:C37';
opts.VariableNames = {'Amount'};
opts.VariableTypes = {'double'};
T = readtable('data.xlsx', opts)Select A Worksheet And Preserve Variable Names
opts = spreadsheetImportOptions('Sheet', 'Data', 'VariableNamingRule', 'preserve');
T = readtable('workbook.xlsx', opts)Using spreadsheetImportOptions with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how spreadsheetImportOptions changes the result.
Run a small spreadsheetImportOptions example, explain the result, then change one input and compare the output.
FAQ
Is the returned value an object?⌄
RunMat represents import options as a scalar struct so MATLAB-style field assignment works naturally and readtable can consume the same value directly.
What happens if VariableTypes asks for a type that cannot parse a column?⌄
readtable raises a typed import error for the offending non-missing value. It does not fall back to a string column when the schema explicitly requested another type.
Can I use the options with text files?⌄
The constructor is spreadsheet-focused, but the struct fields that also apply to text imports are parsed by readtable; spreadsheet-only fields such as Sheet remain valid only for spreadsheet files.
Related Io functions
Tabular
arrayDatastore · csvread · csvwrite · detectImportOptions · dlmread · dlmwrite · fileDatastore · parquetDatastore · parquetinfo · parquetread · readcell · readmatrix · readtable · readtimetable · writecell · writematrix · writetable · writetimetable · xlsread · xlswrite
Repl Fs
addpath · cd · copyfile · delete · dir · exist · fileattrib · fileparts · fullfile · genpath · getenv · getpref · isenv · isfile · isfolder · ispref · ls · matlabroot · memmapfile · mkdir · movefile · open · opentoline · path · pathsep · pcode · pwd · readstruct · rehash · restoredefaultpath · rmdir · rmpath · run · savepath · setenv · setpref · system · tempdir · tempname · uigetdir · uigetfile · uiputfile · unsetenv · userpath · what · winqueryreg · xmlread · xmlwrite
Filetext
fclose · feof · fgetl · fgets · fileread · filewrite · fopen · fprintf · fread · frewind · fwrite · readlines · writelines
Import
Json
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how spreadsheetImportOptions is executed, line by line, in Rust.
- View the source for spreadsheetImportOptions in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.