Back to the main page.
Bug 1202 - some functions are missing function references ('See also ft_XXX)'
| Status | CLOSED FIXED |
| Reported | 2011-11-30 12:57:00 +0100 |
| Modified | 2012-08-23 14:02:02 +0200 |
| Product: | FieldTrip |
| Component: | documentation |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Windows |
| Importance: | P3 normal |
| Assigned to: | Jörn M. Horschig |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: |
Jörn M. Horschig - 2011-11-30 12:57:15 +0100
e.g. ft_headmodelplot (I will just add ft_fetch_sens)
Jörn M. Horschig - 2011-11-30 12:58:51 +0100
oopsi whoopsi, that's a compat function
Boris Reuderink - 2011-12-01 22:17:04 +0100
I can't find these specific references to ft_XXX either: $ find . -name "*.m" | xargs grep ft_XXX yields no matches on SVN revision 4922. Jörn, can I mark this issue as invalid?
Jörn M. Horschig - 2011-12-02 09:38:52 +0100
oh, I didn't mean that that function included 'See also ft_XXX' but I meant that this function is missing the complete See also statement. Is there a way to look for files which do not include a certain statement?
Boris Reuderink - 2011-12-02 12:22:51 +0100
Yes, with $ find . -name "*.m" | xargs grep -L "See also" But that yields 572 files...
- 2011-12-02 12:32:54 +0100
manzana> grep -L "See also" *.m Contents.m fieldtrip2spss.m fieldtripdefs.m ft_analysisprotocol.m ft_channelnormalise.m ft_channelselection.m ft_conjunctionanalysis.m ft_connectivityanalysis.m ft_defaults.m ft_denoise_pca.m ft_dipolesimulation.m ft_documentationindex.m ft_documentationreference.m ft_freqinterpolate.m ft_freqsimulation.m ft_headmodelplot.m ft_headmovement.m ft_movieplotER.m ft_movieplotTFR.m ft_mvaranalysis.m ft_networkanalysis.m ft_prepare_bemmodel.m ft_prepare_concentricspheres.m ft_prepare_localspheres.m ft_prepare_mesh.m ft_prepare_mesh_new.m ft_prepare_singleshell.m ft_qualitycheck.m ft_scalpcurrentdensity.m ft_sliceinterp.m ft_spike_isihist.m ft_spike_jpsth.m ft_spike_maketrials.m ft_spike_plot_isi.m ft_spike_plot_isireturn.m ft_spike_plot_raster.m ft_spike_psth.m ft_spike_rate.m ft_spike_rate_orituning.m ft_spike_triggeredspectrum.m ft_spike_xcorr.m ft_spikedensity.m ft_spikedetection.m ft_spikedownsample.m ft_spiketriggeredaverage.m ft_spiketriggeredspectrum.m ft_stratify.m ft_volumedownsample.m loreta2fieldtrip.m nutmeg2fieldtrip.m spass2fieldtrip.m you can of course do the same thing for the m-files in the modules
- 2011-12-02 12:33:12 +0100
(In reply to comment #4) Oh, I see that Boris beat me to it...
Jörn M. Horschig - 2011-12-02 16:35:29 +0100
looks like a lot of work ;) but for reasons of consistencies and usability it might be handy to figure whether these functions should have references (e.g. get called or call other ft_ functions)
Boris Reuderink - 2011-12-06 12:53:31 +0100
Can anyone think of a systematic way for keeping them up to date?
Boris Reuderink - 2012-01-03 12:17:52 +0100
Bump.
Boris Reuderink - 2012-02-01 14:14:21 +0100
Had a short chat with Jörn, and he is willing to go manually trough the function documentation. Probably the example function on the wiki should be updated with a greppable ft_XXX for new functions. Keeping old functions up to date is difficult though. Assigning to JH.
Jörn M. Horschig - 2012-06-13 17:07:26 +0200
629 $ svn ci fieldtrip2spss.m ft_analysisprotocol.m ft_channelnormalise.m ft_channelselection.m ft_conjunctionanalysis.m ft_connectivityanalysis.m ft_denoise_pca.m ft_dipolesimulation.m ft_freqinterpolate.m ft_freqsimulation.m compat/ft_headmodelplot.m ft_headmovement.m ft_mvaranalysis.m ft_prepare_bemmodel.m ft_prepare_concentricspheres.m ft_prepare_localspheres.m ft_prepare_mesh.m ft_prepare_mesh_new.m ft_prepare_singleshell.m ft_qualitycheck.m ft_scalpcurrentdensity.m ft_sliceinterp.m ft_volumedownsample.m loreta2fieldtrip.m nutmeg2fieldtrip.m spass2fieldtrip.m -m "enhancement - added see also statements" Transmitting file data ........................ Committed revision 6060. I am not sure about some function, but at least it shows some info concerning further reading now. What about future functions and cross-references? Maybe it should be said once in the meeting that everyone of us should have an eye on this?