Back to the main page.
Bug 1733 - implement hints for pipeline structure on wiki
| Status | CLOSED WONTFIX |
| Reported | 2012-09-21 11:21:00 +0200 |
| Modified | 2019-08-10 12:41:05 +0200 |
| Product: | FieldTrip |
| Component: | documentation |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Windows |
| Importance: | P3 normal |
| Assigned to: | Eelke Spaak |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: | http://bugzilla.fcdonders.nl/show_bug.cgi?id=1565 |
Eelke Spaak - 2012-09-21 11:21:32 +0200
E.g., after ft_definetrial the next logical step is often ft_preprocessing. As discussed with Robert and Lilla, I will do the following: - Make a standard syntax that can be added in comments in the matlab source code, after help. Something like the following for ft_preprocessing: % PIPELINE % PREV: ft_definetrial, ft_preprocessing % NEXT: ft_timelockanalysis, ft_freqanalysis, ft_componentanalysis - Update ft_documentationreference such that it extracts these codes and puts them in an appropriate format on the wiki reference page. - Change dokuwiki (e.g. through a custom plugin) such that it knows how to display this information on the reference pages. Preferably through some awesome flowchart or something.
Lilla Magyari - 2012-09-21 16:36:08 +0200
if I remember well, the idea for the update of the reference documentation was the following: use of each function should be described with consistent naming of the input and output data-types: e.g. timelock = ft_timelockanalysis(cfg,preproc) (instead of data=ft_function(cfg,data)) But I think the naming of the data types should be discussed further. Lilla
Robert Oostenveld - 2017-08-17 12:41:20 +0200
I don't think this is ever going to happen, so better close the bug.
Robert Oostenveld - 2019-08-10 12:34:55 +0200
This closes a whole series of bugs that have been resolved (either FIXED/WONTFIX/INVALID) for quite some time. If you disagree, please file a new issue on https://github.com/fieldtrip/fieldtrip/issues.