writecell

Write cell array to file

Syntax

writecell(C)

writecell(C,filename)

writecell(___,Name,Value)

Description

writecell(C) writes cell array C to a comma delimited text file. The file name is the workspace name of the cell array, appended with the extension .txt. If writecell cannot construct the file name from the input cell array name, then it writes to the file cell.txt.

Each column of each variable in C becomes a column in the output file. The writecell function overwrites any existing file.

writecell(C,filename) writes to a file with the name and extension specified by filename.

writecell determines the file format based on the specified extension. The extension must be one of the following:

• .txt, .dat, or .csv for delimited text files

• .xls, .xlsm, or .xlsx for Excel^® spreadsheet files

• .xlsb for Excel spreadsheet files supported on systems with Excel for Windows^®

writecell(___,Name,Value) writes the cell array to a file with additional options specified by one or more Name,Value pair arguments and can include any of the input arguments in previous syntaxes.

Examples

Write Cell Array to Text File

Create a cell array, write it to a comma-separated text file, and then write the cell array to another text file with a different delimiter character.

Create a simple cell array in the workspace.

C =  {1,2,3;
     'text',datetime('today'),hours(1)}

C = 2×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[09-Jan-2019]}    {[1 hr]}

Write the cell array to a comma delimited text file and display the file contents. The writecell function outputs a text file named C.txt.

writecell(C)
type 'C.txt'

1,2,3
text,09-Jan-2019,1 hr

To write the same cell array to a text file with a different delimiter character, use the 'Delimiter' name-value pair.

writecell(C,'C_tab.txt','Delimiter','tab')
type 'C_tab.txt'

1	2	3
text	09-Jan-2019	1 hr

Write Cell Array to Spreadsheet File

Create a cell array, write it to a spreadsheet file, and then read and display the contents of the file.

Create a cell array in the workspace.

C =  {1,2,3;
     'text',datetime('today'),hours(1)}

C = 2×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[09-Jan-2019]}    {[1 hr]}

Write the cell array to a spreadsheet file.

writecell(C,'C.xls')

Read and display the matrix from C.xls.

readcell('C.xls')

ans = 2×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[09-Jan-2019]}    {'1 hr'}

Write Cell Array to Specified Sheet and Range

Create a cell array and write it to a specified sheet and range in a spreadsheet file.

Create a cell array in the workspace.

C =  {1,2,3;
     'text',datetime('today'),hours(1)}

C = 2×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[09-Jan-2019]}    {[1 hr]}

Write the cell array to the file C.xls, in the second worksheet in the file, starting at the third row.

writecell(C,'C.xls','Sheet',2,'Range','A3:C5')

Read and display the cell array.

readcell('C.xls','Sheet',2,'Range','A3:C5')

ans = 2×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[09-Jan-2019]}    {'1 hr'}

Append Cell Array Below Existing Data in Spreadsheet

Append a cell array to the bottom of a spreadsheet file containing existing data.

Create two cell arrays in the workspace.

C =  {1,2,3;
     'text',datetime('today'),hours(1)}

C=2×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[24-Aug-2020]}    {[1 hr]}

rgb = {'red','green','blue'}

rgb = 1x3 cell
    {'red'}    {'green'}    {'blue'}

Write the cell array C to a spreadsheet file called C.xls.

writecell(C,'C.xls')

Append the cell array rgb below the existing data in the spreadsheet file.

writecell(rgb,'C.xls','WriteMode','append')

Read and display the cell array.

readcell('C.xls')

ans=3×3 cell array
    {[   1]}    {[          2]}    {[   3]}
    {'text'}    {[24-Aug-2020]}    {'1 hr'}
    {'red' }    {'green'      }    {'blue'}

Append Cell Array to Bottom of Text File

Append cell arrays to the bottom of a text file containing existing data.

Create three cell arrays in the workspace.

states = {"Massachusetts","New York","Maryland","Virginia"}

states=1×4 cell array
    {["Massachusetts"]}    {["New York"]}    {["Maryland"]}    {["Virginia"]}

stateBird = {"Black-capped chickadee","Eastern bluebird",...
    "Baltimore oriole","Cardinal"}

stateBird=1×4 cell array
  Columns 1 through 3

    {["Black-capped..."]}    {["Eastern blue..."]}    {["Baltimore or..."]}

  Column 4

    {["Cardinal"]}

stateFlower = {"Trailing arbutus","Rose",...
    "Black-eyed Susan","Flowering dogwood"}

stateFlower=1×4 cell array
  Columns 1 through 3

    {["Trailing arb..."]}    {["Rose"]}    {["Black-eyed S..."]}

  Column 4

    {["Flowering do..."]}

Write the cell array states to the file states.txt. Then write the arrays stateBird and stateFlower below the existing entries in the text file.

writecell(states,'states.txt')
writecell(stateBird,'states.txt','WriteMode','append')
writecell(stateFlower,'states.txt','WriteMode','append')

Read and display the cell array.

readcell('states.txt')

ans = 3x4 cell
  Columns 1 through 3

    {'Massachusetts'    }    {'New York'        }    {'Maryland'        }
    {'Black-capped c...'}    {'Eastern bluebird'}    {'Baltimore oriole'}
    {'Trailing arbutus' }    {'Rose'            }    {'Black-eyed Susan'}

  Column 4

    {'Virginia'         }
    {'Cardinal'         }
    {'Flowering dogwood'}

Input Arguments

C — Input cell array

cell array

Input data, specified as a cell array.

filename — File name

character vector | string scalar

File name, specified as a character vector or string scalar.

Depending on the location you are writing to, filename can take on one of these forms.

Location	Form
Current folder	To write to the current folder, specify the name of the file in filename. Example: 'myTextFile.csv'
Other folders	To write to a folder different from the current folder, specify the full or relative path name in filename. Example: 'C:\myFolder\myTextFile.csv' Example: 'myFolder\myExcelFile.xlsx'
Remote Location	To write to a remote location, filename must contain the full path of the file specified as a uniform resource locator (URL) of the form: scheme_name://path_to_file/my_file.ext Based on your remote location, scheme_name can be one of the values in this table. Remote Location scheme_name Amazon S3™ s3 Windows Azure® Blob Storage wasb, wasbs HDFS™ hdfs For more information, see Work with Remote Data. Example: 's3://bucketname/path_to_file/my_file.xlsx'

• If filename includes the file extension, then the writing function determines the file format from the extension. Otherwise, the writing function creates a comma separated text file and appends the extension .txt. Alternatively, you can specify filename without the file’s extension, and then include the 'FileType' name-value pair arguments to indicate the type of file.

• If filename does not exist, then the writing function creates the file.

• If filename is the name of an existing text file, then the writing function overwrites the file.

• If filename is the name of an existing spreadsheet file, then the writing function writes the data to the specified location, but does not overwrite any values outside the range of the input data.

Data Types: char | string

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'FileType',text indicates that the variable names should not be included as the first row of the output file.

Text and Spreadsheet Files

'FileType' — Type of file

'text' | 'spreadsheet'

Type of file, specified as the comma-separated pair consisting of 'FileType' and a character vector or string containing 'text' or 'spreadsheet'.

The 'FileType' name-value pair must be used with the filename input argument. You do not need to specify the 'FileType' name-value pair argument if the filename input argument includes a standard file extension. The following standard file extensions are recognized by the writing function:

• .txt, .dat, or .csv for delimited text files

• .xls, .xlsm, or .xlsx for Excel spreadsheet files

• .xlsb for Excel spreadsheet files supported on systems with Excel for Windows

Example: 'FileType','spreadsheet'

Data Types: char | string

'DateLocale' — Locale for writing dates

character vector | string scalar

Locale for writing dates, specified as the comma-separated pair consisting of 'DateLocale' and a character vector or a string scalar. When writing datetime values to the file, use DateLocale to specify the locale in which writecell should write month and day-of-week names and abbreviations. The character vector or string takes the form xx_YY, where xx is a lowercase ISO 639-1 two-letter code indicating a language, and YY is an uppercase ISO 3166-1 alpha-2 code indicating a country. For a list of common values for the locale, see the Locale name-value pair argument for the datetime function.

The writing function ignores the 'DateLocale' parameter value whenever dates can be written as Excel-formatted dates.

Example: 'DateLocale','ja_JP'

Data Types: char | string

'WriteMode' — Writing mode

character vector | string scalar

Writing mode, specified as the comma-separated pair consisting of 'WriteMode' and a character vector or a string scalar. Select a write mode based on the file type.

File Type	Write Mode
Text Files	'overwrite' (default) — Overwrite the file. 'append' — Append data to the file. If the file you specified does not exist, then the writing function creates and writes data to a new file.
Spreadsheet Files	'inplace' (default) — Update only the range occupied by the input data. The writing function does not alter any data outside of the range occupied by the input data. If you do not specify a sheet, then the writing function writes to the first sheet. 'overwritesheet' — Clear the specified sheet and write the input data to the cleared sheet. If you do not specify a sheet, then the writing function clears the first sheet and writes the input data to it. 'append' — The writing function appends the input data to the bottom of the occupied range of the specified sheet. If you do not specify a sheet, then the writing function appends the input data to the bottom of the occupied range of the first sheet. 'replacefile' — Remove all other sheets from the file, then clear and write the input data to the to the specified sheet. If you do not specify a sheet, then the writing function removes all other sheets from the file, and then clears and writes the input data to the first sheet. If the file you specified does not exist, then the writing function creates a new file and writes the input data to the first sheet.

• When WriteVariableNames is set to true, the writing function does not support the write mode 'append'.

• For spreadsheet files:

  • When the write mode is 'append', the writing function does not support the Range parameter.

  • If the file you specified does not exist, then the writing function performs the same actions as 'replacefile'.

Example: 'WriteMode','append'

Data Types: char | string

Text Files Only

'Delimiter' — Field delimiter character

character vector | string scalar

Field delimiter character, specified as the comma-separated pair consisting of 'Delimiter' and a character vector or string scalar containing one of these specifiers:

Specifier	Field Delimiter
',' 'comma'	Comma. This is the default behavior.
' ' 'space'	Space
'\t' 'tab'	Tab
';' 'semi'	Semicolon
'|' 'bar'	Vertical bar

You can use the 'Delimiter' name-value pair only for delimited text files.

Example: 'Delimiter','space'

Data Types: char | string

'QuoteStrings' — Indicator for writing quoted text

false (default) | true

Indicator for writing quoted text, specified as the comma-separated pair consisting of 'QuoteStrings' and either false or true. If 'QuoteStrings' is true, then the writing function encloses the text in double quotation marks and replaces any double-quote characters that appear as part of that text with two double-quote characters.

You can use the 'QuoteStrings' name-value pair only with delimited text files.

'Encoding' — Character encoding scheme

'UTF-8' (default) | 'ISO-8859-1' | 'windows-1251' | 'windows-1252' | ...

Character encoding scheme associated with the file, specified as the comma-separated pair consisting of 'Encoding' and 'system' or a standard character encoding scheme name. When you do not specify any encoding, the writing function uses UTF-8 to write the file.

Example: 'Encoding','UTF-8' uses UTF-8 as the encoding.

Data Types: char | string

Spreadsheet Files Only

'Sheet' — Worksheet to write to

character vector | string scalar | positive integer

Worksheet to write to, specified as the comma-separated pair consisting of 'Sheet' and a character vector or a string scalar containing the worksheet name or a positive integer indicating the worksheet index. The worksheet name cannot contain a colon (:). To determine the names of sheets in a spreadsheet file, use sheets = sheetnames(filename). For more information, see sheetnames.

Specify the worksheet to write to by name or index:

• name — If the specified sheet name does not exist in the file, then the writing function adds a new sheet at the end of the worksheet collection.

• index — If the specified sheet index is an index larger than the number of worksheets, then the writing function appends empty sheets until the number of worksheets in the workbook equals the sheet index. The writing function also generates a warning indicating that it has added a new worksheet.

You can use the 'Sheet' name-value pair only with spreadsheet files.

Example: 'Sheet',2

Example: 'Sheet', 'MySheetName'

Data Types: char | string | single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

'Range' — Rectangular portion of worksheet to write to

character vector | string scalar

Rectangular portion of worksheet to write to, specified as the comma-separated pair consisting of 'Range' and a character vector or string scalar in one of the following forms.

Form of the Value of Range	Description
'Corner1'	Corner1 specifies the first cell of the region to write. The writing function writes the data starting at this cell. Example: 'Range','D2'
'Corner1:Corner2'	Corner1 and Corner2 are two opposing corners that define the region to write. For example, 'D2:H4' represents the 3-by-5 rectangular region between the two corners D2 and H4 on the worksheet. The 'Range' name-value pair argument is not case sensitive, and uses Excel A1 reference style (see Excel help). Example: 'Range','D2:H4' If the range you specify is smaller than the size of the input data, then the writing function writes only a subset of the input data that fits into the range. If the range you specify is larger than the size of the input data, then the writing function leaves the remainder of the region as it is.

The 'Range' name-value pair can only be used with Excel files.

Example: 'Range', 'A1:F10'

Data Types: char | string

'UseExcel' — Flag to start instance of Microsoft Excel for Windows

false (default) | true

Flag to start an instance of Microsoft^® Excel for Windows when writing spreadsheet data, specified as the comma-separated pair consisting of 'UseExcel' and either true, or false.

You can set the 'UseExcel' parameter to one of these values:

• true — The writing function starts an instance of Microsoft Excel when writing the file.

• false — The writing function does not start an instance of Microsoft Excel when writing the file. When operating in this mode, functionality for writing differs in the support of file formats and interactive features, such as formulas and macros.

UseExcel	true	false
Supported file formats	.xls, .xlsx, .xlsm, .xltx, .xltm, .xlsb, .ods	.xls, .xlsx, .xlsm, .xltx, .xltm
Support for interactive features, such as formulas and macros	Yes	No

When writing to spreadsheet files on Windows platforms, if you want to start an instance of Microsoft Excel, then set the 'UseExcel' parameter to true.

'AutoFitWidth' — Automatically adjust column width

true (default) | false

Automatically adjust column width, specified as true or false. If you specify a value of 0 or false, then writecell will not automatically adjust the column widths to fit the data in the cells.

Example: 'AutoFitWidth',0

'PreserveFormat' — Preserve existing format

true (default) | false

Preserve existing format of the original data, specified as true or false. If you specify false, then writecell will not preserve the cell formatting of the original data, such as fonts, cell borders, and color-shaded cells.

When you write datetime data to a spreadsheet file, you must set both 'PreserveFormat' and the 'UseExcel' name-value pair to true to preserve the existing cell formatting. If 'UseExcel' is set to false and 'PreserveFormat' is set to true when you write datetime data to the file, writecell will not preserve the existing cell formatting of the file.

Example: 'PreserveFormat',0

Limitations

• To set the 'PreserveFormat' name-value pair to true, you must set the 'UseExcel' name-value pair to true.

Algorithms

There are some instances where the writecell function creates a file that does not represent the input data exactly. You will notice this when you use the readcell function to read that file. The resulting data might not have the exact same format or contents as the original data. If you need to save your cell array and retrieve it at a later time to exactly match the original cell array, with the same data and organization, then save it as a MAT-file. writecell writes an inexact table in the following instances:

• writecell writes out numeric data using long g format, and categorical or character data as unquoted text.

• writecell writes out cell arrays that have more than two dimensions as two dimensional arrays, with the trailing dimensions collapsed.