Back to the main page.

Bug 178 - document cfg.inputfile and cfg.outputfile

Status CLOSED FIXED
Reported 2010-10-06 16:59:00 +0200
Modified 2011-03-23 10:09:05 +0100
Product: FieldTrip
Component: documentation
Version: unspecified
Hardware: PC
Operating System: Mac OS
Importance: P1 normal
Assigned to: Eelke Spaak
URL:
Tags:
Depends on:
Blocks:
See also:

Robert Oostenveld - 2010-10-06 16:59:35 +0200

ft_sourceanalysis and many other functions suppor cfg.inputfile and outputfile, but it is not documented. We have to make a consistent documentation of those options throughout all (relevalt) ft functions. Perhaps in a seperate section in the help like this % ... % % To facilitate data-handling and distributed computing with the peer-to-peer module, this % function has the following options % cfg.inputfile = ... % cfg.outputfile = ... % If you specify one of these (or both) the input data will be read from a *.mat file on disk % and/or the output data will be written to a *.mat file. These mat files should contain only a % single variable, corresponding with the input/output structure. % % ... [[to be discussed]]