Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
erikhuizinga committed Apr 9, 2017
1 parent 8d32543 commit d2a40b6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,11 @@ If no plots are created, the `'PlotStatistics'` value is ignored.

Assume constant residual variance in the simple linear regression performed if the `'PlotStatistics', 'regression'` Name-Value pair argument is specified. This means the upper and lower limits of agreement lines will have the same slope as the bias line. This assumption holds if the slope of the upper and lower limits of agreement do not differ significantly from the slope of the bias regression line.

### `'ScatterSet'`: Use (part of) the input data in the scatter graphs
`'full'` (default) | `'mean'`

Use the specified data set for the graphs. If `'full'` is specified (default), then all observation pairs in the input data are used in the graphs. If `'mean'` is specified, then the subject mean is used in the graphs. The plot titles are adjusted accordingly. This Name-Value pair argument only affects BAA for repeated measurements, because the subject mean without repeated measurement equals all observation pairs. However, the plot titles will reflect the chosen set anyway. This option does not affect the mean-standard deviation graphs, because the standard deviation always is one observation per subject.

### `'ConstantTrueValue'`: Assume the true value is constant
`true` (default) | `false`

Expand Down
12 changes: 12 additions & 0 deletions ba.m
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,18 @@
% on the mean, resulting in the possibility of non-constant lines.
% If no plots are created, the 'PlotStatistics' value is ignored.
%
% 'ScatterSet': Use (part of) the input data in the scatter graphs
% 'full' (default) | 'mean'
% Use the specified data set for the graphs. If 'full' is specified
% (default), then all observation pairs in the input data are used in the
% graphs. If 'mean' is specified, then the subject mean is used in the
% graphs. The plot titles are adjusted accordingly. This Name-Value pair
% argument only affects BAA for repeated measurements, because the
% subject mean without repeated measurement equals all observation pairs.
% However, the plot titles will reflect the chosen set anyway. This
% option does not affect the mean-standard deviation graphs, because the
% standard deviation always is one observation per subject.
%
% 'ConstantResidualVariance': Assume constant residual variance
% false (default) | true
% Assume constant residual variance in the simple linear regression
Expand Down

0 comments on commit d2a40b6

Please sign in to comment.