Back to the main page.

Bug 1690 - peer-to-peer should not be mentioned in the reference documentation

Reported 2012-09-02 22:50:00 +0200
Modified 2013-09-18 13:19:15 +0200
Product: FieldTrip
Component: documentation
Version: unspecified
Hardware: PC
Operating System: Mac OS
Importance: P3 normal
Assigned to: Robert Oostenveld
Depends on:
See also:

Robert Oostenveld - 2012-09-02 22:50:20 +0200

There are quite a few functions that have a section like 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. First, peer-to-peer will become deprecated, we prefer qsubcellfun and enginecellfun. Second, it takes a lot of space, whereas few people will use it. I suggest another style of documentation, perhaps as in % = Nx1 cell-array with selection of channels (default = 'all'), % see FT_CHANNELSELECTION for details i.e. refer to another documentation placeholder. Or include a faq on the wiki and a link in the code? Or perhaps just shorten it to To facilitate data-handling in scripts and distributed computing, this function has the following options: cfg.inputfile = string or cell-array, file(s) to read the input data from cfg.outputfile = string, file to write the output data to

Robert Oostenveld - 2012-09-02 22:51:50 +0200

mbp> grep -l peer-to-peer *.m shows the following list ft_appenddata.m ft_appendfreq.m ft_artifact_clip.m ft_artifact_ecg.m ft_artifact_eog.m ft_artifact_jump.m ft_artifact_muscle.m ft_artifact_threshold.m ft_channelnormalise.m ft_channelrepair.m ft_clusterplot.m ft_combineplanar.m ft_componentanalysis.m ft_componentclassification.m ft_connectivityanalysis.m ft_denoise_synthetic.m ft_dipolefitting.m ft_examplefunction.m ft_freqanalysis.m ft_freqanalysis_mvar.m ft_freqdescriptives.m ft_freqgrandaverage.m ft_freqinterpolate.m ft_freqstatistics.m ft_lateralizedpotential.m ft_layoutplot.m ft_megplanar.m ft_megrealign.m ft_movieplotER.m ft_movieplotTFR.m ft_multiplotER.m ft_multiplotTFR.m ft_mvaranalysis.m ft_networkanalysis.m ft_prepare_leadfield.m ft_prepare_localspheres.m ft_prepare_mesh.m ft_prepare_mesh_new.m ft_prepare_singleshell.m ft_preprocessing.m ft_redefinetrial.m ft_regressconfound.m ft_rejectartifact.m ft_rejectcomponent.m ft_rejectvisual.m ft_resampledata.m ft_scalpcurrentdensity.m ft_singleplotER.m ft_sourceanalysis.m ft_sourcedescriptives.m ft_sourcegrandaverage.m ft_sourceinterpolate.m ft_sourcemovie.m ft_sourceplot.m ft_sourcewrite.m ft_timelockanalysis.m ft_timelockbaseline.m ft_timelockgrandaverage.m ft_timelockstatistics.m ft_topoplotCC.m ft_topoplotTFR.m ft_volumedownsample.m ft_volumenormalise.m ft_volumerealign.m ft_volumereslice.m ft_volumesegment.m ft_volumewrite.m

Lilla Magyari - 2013-07-23 23:20:02 +0200

reassigned to joint development user. lilla

Robert Oostenveld - 2013-08-07 17:14:28 +0200

I have updated the help: removed the specific reference to peer-to-peer, mention distributed computing only in general for inputfile/outputfile. See for the full list of files that was changed.

Robert Oostenveld - 2013-08-07 17:15:14 +0200

I checked the documentation with grep, peer is properly removed (except for some compat files).

Robert Oostenveld - 2013-09-18 13:19:15 +0200

closed multiple bugs that have been resolved