Skip to content

Commit

Permalink
minor clarification to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
acp29 committed Apr 25, 2024
1 parent cc24e59 commit 3240e2e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
12 changes: 6 additions & 6 deletions inst/bootint.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
% -- Function File: CI = bootint (Y)
% -- Function File: CI = bootint (Y, PROB)
%
% 'CI = bootint (Y)' computes 95% percentile confidence intervals using data
% from the vector, or rows* of the matrix, Y, where Y contains bootstrap
% statistics, such as those obtained using the `bootstrp` function. Note
% that, depending on the application, bootstrap confidence intervals with
% better coverage and accuracy can be computed using the various dedicated
% 'CI = bootint (Y)' computes 95% percentile confidence intervals from
% the vector, or rows* of the matrix, Y, where Y contains bootstrap
% statistics, such as those generated using the `bootstrp` function.
% Depending on the application, bootstrap confidence intervals with better
% coverage and accuracy can be computed using the various dedicated
% bootstrap functions from the statistics-resampling package.
%
% * The matrix should have dimensions P * NBOOT, where P corresponds to
Expand Down Expand Up @@ -105,7 +105,7 @@
CI(j, 1) = interp1 (cdf, t1, PROB(1) , 'linear', min (t1));
CI(j, 2) = interp1 (cdf, t1, PROB(2) , 'linear', max (t1));
end
CI(:,isnan(PROB)) = NaN;
CI(:, isnan(PROB)) = NaN;
if (PROB(1) == 0)
CI(:, 1) = -inf;
end
Expand Down
10 changes: 6 additions & 4 deletions inst/credint.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
% -- Function File: CI = credint (Y)
% -- Function File: CI = credint (Y, PROB)
%
% 'CI = credint (Y)' computes 95% credible intervals of data in the vector,
% or rows* of the matrix, Y. The credible intervals are shortest probability
% intervals (SPI), which represent a more computationally stable version of
% the highest posterior density interval [1,2].
% 'CI = credint (Y)' computes 95% credible intervals from the vector, or
% rows* of the matrix, Y, where Y contains posterior (or Bayesian bootstrap)
% statistics, such as those generated using the `bootbayes` function. The
% credible intervals are shortest probability intervals (SPI), which
% represent a more computationally stable version of the highest posterior
% density interval [1,2].
%
% * The matrix should have dimensions P * NBOOT, where P corresponds to
% the number of parameter estimates and NBOOT corresponds to the number
Expand Down

0 comments on commit 3240e2e

Please sign in to comment.