Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
5.5.2 - English

Change language to:
Français - 日本語 - Português - Русский

Please note that the recommended version of Scilab is 2024.0.0. This page might be outdated.
See the recommended documentation of this function

Scilab Help >> Spreadsheet > csvWrite

csvWrite

Write comma-separated value file

Calling Sequence

csvWrite(M, filename)
csvWrite(M, filename, separator)
csvWrite(M, filename, separator, decimal)
csvWrite(M, filename, separator, decimal, precision)
csvWrite(M, filename, separator, decimal, precision, comments)

Arguments

filename

a 1-by-1 matrix of strings, the file path.

M

a m-by-n matrix of strings or double (complex supported).

separator

a 1-by-1 matrix of strings, the column separator mark.

decimal

a 1-by-1 matrix of strings, the decimal mark. The available values are "." or ",".

precision

a 1-by-1 matrix of strings, the C format.

comments

a m-by-1 matrix of strings, the comments stored at the beginning of the file. This option may be used, for example, to put a licence header in a data file.

Description

This function writes matrix M into filename as comma-separated values.

The default value of the optional input arguments are defined by the csvDefault function.

Any optional input argument equal to the empty matrix [] is set to its default value.

If the file filename already exists, it is overwritten.

If relevant (ie with 'special' characters), the file will be saved as UTF-8.

Examples

In the following example, we combine the csvWrite and csvRead functions.

// Save a matrix as csv file format
M = [1:10] * 0.1;
filename = fullfile(TMPDIR, "data.csv");
csvWrite(M, filename);

// Read as text
mgetl(filename)

r = csvRead(filename);

In the following example, we use various options of the csvWrite function.

// Save a matrix as csv file format
M = rand(2,3);
filename = fullfile(TMPDIR, "data.csv");
//
// Use tabs as the separator
csvWrite(M, filename,ascii(9));
mgetl(filename)
//
// Use the "," as the decimal point
// (and blank space as the separator).
csvWrite(M, filename," ",",");
mgetl(filename)
//
// Configure the precision.
// Caution: this lower precision may generate
// errors in a write-read cycle!
csvWrite(M, filename,[],[],"%.8e");
mgetl(filename)
//
// Configure the comments
comments = [
"// Copyright (C) INRIA"
"//  This file must be used under the terms of the CeCILL."
];
csvWrite(M, filename,[],[],[],comments);
mgetl(filename)

The following examples are more advanced uses of the csvWrite function.

A = [
1 0 200 %inf 0
1 1.e-300 200 %inf 0
9.99999999999990010e-001 9.99999999999999980e-201 200 3.15e300 102
9.99999999899999990e-001 1.e-100 200 296 117
1 %inf -%inf %nan 0
];

// Write into a file
filename=fullfile(TMPDIR,"foo.csv");
csvWrite ( A , filename );
edit(filename)

See Also

History

VersionDescription
5.4.0 Function introduced. Based on the 'csv_readwrite' module.
Report an issue
<< csvTextScan Spreadsheet read_csv >>

Copyright (c) 2022-2023 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Wed Apr 01 10:14:07 CEST 2015