To allow for cross-linking, please use the “See also” section at the bottom of the function help. The help of all FieldTrip functions is listed in the reference documentation. Provide reference documentation in the function help Also, it demonstrates how one should document the function according to FT standard guidelines. (Note: this is true as of Feb 11, 2011.) It shows the best practices that one should adhere to concerning input and output structure and data handling. The easiest way to get started with writing a new high-level FieldTrip function is to take a close look at ft_examplefunction, which is located in FT’s core (root) directory.
The function should always start with a help section, that explains the purpose of the function, the type of input data that it expects, the type of output data that it will produce and the configurable options that the user has to control the behavior of the function. Where some functions might not need inputargs and some functions might not return outputargs.
0 kommentar(er)
