Back to the main page.
Bug 477 - implement an ft_examplefunction function
| Status | CLOSED FIXED |
| Reported | 2011-02-07 12:56:00 +0100 |
| Modified | 2011-02-16 14:59:45 +0100 |
| Product: | FieldTrip |
| Component: | core |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Mac OS |
| Importance: | P1 trivial |
| Assigned to: | Eelke Spaak |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: |
Robert Oostenveld - 2011-02-07 12:56:21 +0100
which would serve as the best example for external contributors. It should be consistent with all code and documentation guidelines and should cover help structure and formatting, use as, see also (required for ft_documentationxxx functions) ft_checkconfig handle cfg defaults ft_checkdata inputfile (optional) ft_selectdata do the computation add the cfg at the end ft_checkconfig (switch off tracking) outputfile (optional) Perhaps also other stuff?
Robert Oostenveld - 2011-02-10 11:36:50 +0100
I have just implemented ft_examplefunction and added it to svn (rev 2855). @Eelke: can you look at whether the function makes sense like this? Would this be enough to help you write a new high-level function? The function should also be documented on http://fieldtrip.fcdonders.nl/code_guidelines
Eelke Spaak - 2011-02-10 12:33:44 +0100
(In reply to comment #1) > @Eelke: can you look at whether the function makes sense like this? Would this > be enough to help you write a new high-level function? Yes, it seems very clear and helpful. One remark: on line 81, the script 'touches' the cfg.outputfile field. This was sort of out-of-the-blue for me; I did not know functions supported an cfg.outputfile field in general. Maybe we could add some comment on this feature before line 81? > The function should also be documented on > http://fieldtrip.fcdonders.nl/code_guidelines I will do this.