Mercurial > octave
view scripts/io/csvread.m @ 28959:5394d688d456
doc: Use @code{} within alternate text for @xref,@pxref macros for better Info display.
* accumarray.m, structfun.m, slash.m, csvread.m, csvwrite.m, edit.m,
setfield.m, lsqnonneg.m, pqpnonneg.m, camlookat.m, camorbit.m, camup.m, barh.m,
camlight.m, isocaps.m, isosurface.m, loglogerr.m, polar.m, reducepatch.m,
reducevolume.m, semilogxerr.m, semilogyerr.m, findall.m, findobj.m, beta.m,
movmad.m, movmax.m, movmean.m, movmedian.m, movmin.m, movprod.m, movstd.m,
movsum.m, movvar.m, test.m, datenum.m:
Place alternate text in @code{} macro so it displays better in plaintext Info.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Oct 2020 09:33:28 -0700 |
parents | bd51beb6205e |
children | 7854d5752dd2 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2001-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{x} =} csvread (@var{filename}) ## @deftypefnx {} {@var{x} =} csvread (@var{filename}, @var{dlm_opt1}, @dots{}) ## Read the comma-separated-value (CSV) file @var{filename} into the matrix ## @var{x}. ## ## Note: only CSV files containing numeric data can be read. ## ## This function is equivalent to ## ## @example ## @var{x} = dlmread (@var{filename}, "," , @var{dlm_opt1}, @dots{}) ## @end example ## ## Any optional arguments are passed directly to @code{dlmread} ## (@pxref{XREFdlmread,,@code{dlmread}}). ## @seealso{dlmread, textscan, csvwrite, dlmwrite} ## @end deftypefn function x = csvread (filename, varargin) x = dlmread (filename, ",", varargin{:}); endfunction ## Tests for csvread() are in csvwrite() ## Mark file as being tested %!assert (1)