Merge pull request #921 from bachlab/typos

Typo corrections in function help text

Author: dominikbach

src/pspm_convert_area2diameter.m

@@ -10,7 +10,7 @@
 %   [sts, channel_index]  = pspm_convert_area2diameter(fn, options)
 %   [sts, converted_data] = pspm_convert_area2diameter(area)
 % ● Arguments
-%   *            fn : a numeric vector of milimeter values
+%   *            fn : a numeric vector of millimeter values
 %   *          area : a numeric vector of area values (the unit is not important)
 %   ┌───────options :
 %   ├──────.channel : [optional][numeric/string] [Default: 'both']

src/pspm_convert_ecg2hb_amri.m

@@ -1,7 +1,7 @@
 function [sts, out_channel] = pspm_convert_ecg2hb_amri(fn, options)
 % ● Description
 %   pspm_convert_ecg2hb_amri performs R-peak detection from an ECG signal using the steps
-%   decribed in R-peak detection section of [1]. This function uses a modified version of
+%   described in R-peak detection section of [1]. This function uses a modified version of
 %   the original amri_eeg_rpeak.m code that can be obtained from [2]. The modified version with a list
 %   of changes made is provided with PsPM in the amri_eegfmri directory.
 % ● Format
@@ -24,7 +24,7 @@
 %   │                 Choose which signal will be used as the input to the core R-peak
 %   │                 detection steps.
 %   │                 (1) If 'ecg', filtered ECG signal will be used.
-%   │                 (2) If 'teo', Teager Enery Operator will be applied to the filtered
+%   │                 (2) If 'teo', Teager Energy Operator will be applied to the filtered
 %   │                     ECG signal before feeding it to R-peak finding part.
 %   │                 (3) If 'auto', the option that results in the higher maximal
 %   │                     auto-correlation will be used.

src/pspm_dcm.m

@@ -93,7 +93,7 @@
 %   │             only recommended for long inter-trial-intervals and 
 %   │             should be used with caution. In reference 2, this option 
 %   │             lead to worse quality of the trial-by-trial amplitude 
-%   │             estimation (potenetially due to overfitting the data 
+%   │             estimation (potentially due to overfitting the data 
 %   │             available to estimate the response function).
 %   │             Default: 0.
 %   ├─────.getrf: Only estimate response function, do not do trial-wise DCM.
@@ -104,7 +104,7 @@
 %   │             progress trial-by-trial and consider this number of 
 %   │             trials into the future, until the last trial of a session. 
 %   │             If this parameter is larger than the number of trials in 
-%   │             a session, the entire sessin will be inverted at 
+%   │             a session, the entire session will be inverted at 
 %   │             the same time. In reference 2, this parameter (set to 2
 %   │             or 3) had no impact on the quality of the estimation. 
 %   │             Unpublished data suggest that if a session with 24 trials 

src/pspm_expand_epochs.m

@@ -17,7 +17,7 @@
 %   *   expansion:  A 2-element vector with positive numbers [pre, post]
 %   ┌────────────options:
 %   ├─────────.overwrite: Define if already existing files should be
-%   │                     overwritten. Default ist 2. (Only used if input
+%   │                     overwritten. Default is 2. (Only used if input
 %   │                     is epochs file.)
 %   └────.channel_action: Channel action, add / replace existing data
 %                         data (default: add)

src/pspm_extract_segments.m

@@ -37,19 +37,19 @@
 %   ├────────────.length: Length of the segments in the specified 'timeunits'.
 %   │                     The default value is 10.
 %   ├──────────────.plot: [0/1] Plot mean values (solid) and standard error of
-%   │                     the mean (dashed) will be ploted. Default is no plot.
+%   │                     the mean (dashed) will be plotted. Default is no plot.
 %   ├────────.outputfile: Define filename to store segments. If is equal
 %   │                     to '', no file will be written. Default is 0.
 %   ├─────────.overwrite: Define if already existing files should be
-%   │                     overwritten. Default ist 0.
+%   │                     overwritten. Default is 0.
 %   ├───.marker_chan_num: Optional if timeunits are 'markers'. Channel
 %   │                     identifier for the marker channel. Default: first
 %   │                     marker channel in the file.
 %   ├───────────.missing: allows to specify missing (e. g. artefact) epochs in the
 %   │                     data file. See pspm_get_timing for epoch definition;
 %   │                     specify a cell array for multiple input files. This
 %   │                     must always be specified in SECONDS. if method is
-%   │                     'model', then this option overides the missing
+%   │                     'model', then this option overrides the missing
 %   │                     values given in the model
 %   │                     Default: no missing values
 %   ├────────.nan_output: ['screen', filename, or 'none'] Output

src/pspm_find_sounds.m

@@ -5,7 +5,7 @@
 %   of startle sounds for GLM-based analysis of startle eye blink data. The
 %   detected events are written into a marker channel. 
 %   A sound is detected as event if it is longer than 10 ms, and events are
-%   recognized as distinct if they are at least 50 ms appart. Various
+%   recognized as distinct if they are at least 50 ms apart. Various
 %   options allow customizing the algorithm to specific experimental
 %   settings. In particular, events can be constrained to be in the
 %   vicinity of event markers, and/or a desired number of events can be 
@@ -40,7 +40,7 @@
 %   ├──────.mindelay : [number] Lower limit (in seconds) of the window in which
 %   │                  pspm_find_sounds will accept sounds as relating to a marker.
 %   │                  Default is 0 s.
-%   ├──────────.plot : [0(default) or 1] Display a histogramm of the delays found and a plot
+%   ├──────────.plot : [0(default) or 1] Display a histogram of the delays found and a plot
 %   │                  with the detected sound, the trigger and the onset of the sound
 %   │                  events. These are color coded for delay, from green (smallest
 %   │                  delay) to red (longest). Forces the 'diagnostics' option to true.
@@ -73,7 +73,7 @@
 % ● Outputs
 %   *  channel_index : index of channel containing the processed data
 %   ┌───────────info
-%   ├───.snd_markers : vector of begining of sound sound events
+%   ├───.snd_markers : vector of beginning of sound events
 %   └────────.delays : vector of delays between markers and detected sounds. Only
 %                      available with option 'diagnostics' turned on.
 % ● History

src/pspm_find_valid_fixations.m

@@ -2,7 +2,7 @@
 % ● Description
 %   pspm_find_valid_fixations finds deviations from a specified gaze
 %   fixation area. The primary usage of this function is to improve
-%   analyis of pupil size. Pupil size data will be incorrect when gaze is
+%   analysis of pupil size. Pupil size data will be incorrect when gaze is
 %   not in forward direction, due to foreshortening error. This function
 %   allows excluding pupil data points with too large foreshortening. To do
 %   so, it acts on one (or two) pupil channel(s), together with the
@@ -34,7 +34,7 @@
 %   *         bitmap : A nxm matrix of the same size as the display, with 1
 %                      for valid and 0 for invalid gaze points. IMPORTANT: the bitmap has to
 %                      be defined in terms of the eyetracker coordinate system, i.e.
-%                      bitmap(1,1) must correpond to the origin of the eyetracker
+%                      bitmap(1,1) must correspond to the origin of the eyetracker
 %                      coordinate system, and must be of the same size as
 %                      the display.
 %   *  circle_degree : Size of boundary circle given in degree visual angles.

src/pspm_process_illuminance.m

@@ -22,7 +22,7 @@
 %                     [or directly specify ldata as a vector].
 %   *             sr: Sample rate in Hz of the input illuminance data.
 %   ┌────────options
-%   ├────────────.fn: [filename] Ff specified ldata{i,j} will be saved to a file
+%   ├────────────.fn: [filename] If specified ldata{i,j} will be saved to a file
 %   │                 with filename options.fn{i,j} into the variable 'R'.
 %   ├─────.overwrite: [logical] (0 or 1)
 %   │                 Define whether to overwrite existing output files or not.

src/pspm_split_sessions.m

@@ -12,7 +12,7 @@
 %   first session and the end of the last session.
 %   In addition, the function can split a (missing) epochs file associated
 %   with the original PsPM file to the same limits.
-%   The individual session dat will be written to new files with a suffix 
+%   The individual session data will be written to new files with a suffix 
 %   '_sn' and the session number.
 % ● Format
 %   [sts, newdatafile, newepochfile] = pspm_split_sessions(datafile, options)
@@ -45,7 +45,7 @@
 %   │                    file. Markers within the suffix period will be dropped.
 %   ├───────.randomITI : [default:0]
 %   │                    Tell the function to use all the markers to evaluate the mean
-%   │                    distance between them. Usefull for random ITI since it reduces
+%   │                    distance between them. Useful for random ITI since it reduces
 %   │                    the variance.
 %   ├─────────.verbose : [default:1] printing processing messages.
 %   └─────────.missing : Optional name of an epoch file, e.g. containing a missing epochs

src/pspm_tam.m

@@ -45,7 +45,7 @@
 %   ├.std_exp_cond: [optional] allows to specify the standard experimental condition
 %   │               as a string or an index in timing.names.
 %   │               if specified this experimental condition will be
-%   │               substracted from all the other conditions.
+%   │               subtracted from all the other conditions.
 %   │               DEFAULT: 'none'
 %   └───.norm_max:  [optional] set the first peak at 1 before model fitting.
 %                   DEFAULT: 0 (not normalize)