Back to the main page.

Bug 887 - help of ft_determine_coordsys could be improved

Status CLOSED FIXED
Reported 2011-08-23 15:53:00 +0200
Modified 2011-08-31 14:49:48 +0200
Product: FieldTrip
Component: documentation
Version: unspecified
Hardware: PC
Operating System: Linux
Importance: P1 normal
Assigned to: Jan-Mathijs Schoffelen
URL:
Tags:
Depends on:
Blocks:
See also:

Lilla Magyari - 2011-08-23 15:53:40 +0200

Hi, I think there are some small mistakes in the help of this function. They aren't severe but it could be fixed. Help looks like this: "FT_DETERMINECOORDSYS plots a geometrical object, allowing you to perform a visual check on the coordinatesystem, the units and on the anatomical labels for the coordinate system axes." shouldn't be FT_DETERMINE_COORDSYS? " Use as [dataout] = ft_checkcoordsys(datain, varargin) where the input data structure can be - an anatomical MRI, which can be segmented - an electrode or gradiometer definition - a volume conduction model or most other FieldTrip structures that represent geometrical information." ft_checkcoordsys is the old name of this function " The optional key-value pairs are interactive = string, 'yes' or 'no' (default = 'yes')" Is it explained in the tutorial or anywhere how to use the "varargin"/key-value pairs? Or is it something that Matlab-users should know? because for me, it took some time until I realized that I have to add these arguments like this: function(data, 'interactive', 'yes') It is not clear from this help. Best, Lilla


Jan-Mathijs Schoffelen - 2011-08-29 14:58:11 +0200

OK, thanks for the feedback, and suggested fixes. I updated the documentation. Could you at some point check whether you agree?


Lilla Magyari - 2011-08-31 11:04:31 +0200

(In reply to comment #1) > OK, thanks for the feedback, and suggested fixes. I updated the documentation. > Could you at some point check whether you agree? hi, thanks for the changes. It is fine. Lilla