Skip to content

Commit

Permalink
updates all references to package name
Browse files Browse the repository at this point in the history
  • Loading branch information
acp29 committed Dec 24, 2023
1 parent 0d61365 commit fe06a1f
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 33 deletions.
12 changes: 6 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: statistics-bootstrap
version: 5.4.3
date: 2023-12-22
name: statistics-resampling
version: 5.4.4
date: 2023-12-24
author: Andrew Penn <[email protected]>
maintainer: Andrew Penn <[email protected]>
title: A statistics package with a variety of bootstrap resampling tools
title: A statistics package with a variety of resampling tools
categories: package
Description: This package of functions can be used to estimate
bias, uncertainty (standard errors and confidence intervals),
prediction error, and test hypotheses (p-values) using bootstrap
resampling. Variations of the bootstrap are included that improve
prediction error, and test hypotheses (p-values) using resampling
methods. Variations of the bootstrap are included that improve
the coverage and accuracy of bootstrap confidence intervals for
small samples and samples with complex dependence structures.
License: GPLv3+
Expand Down
3 changes: 0 additions & 3 deletions PKG_ADD
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,4 @@ else
end
end

fprintf (strcat ('Note that this is the last release of the ''statistics-bootstrap'' package.\n', ...
'Newer versions of this package will be renamed ''statistics-resampling''.\n'));

clear dirlist dirname
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# statistics-bootstrap package
# statistics-resampling package

## Package maintainer
Andrew Penn ([email protected])
Expand All @@ -19,7 +19,7 @@ Core functions in this package are known to be compatible with versions of Octav

## Installation

To install (or test) the statistics-bootstrap package at it's existing location in either Octave or Matlab, follow these steps:
To install (or test) the statistics-resampling package at it's existing location in either Octave or Matlab, follow these steps:

* Download the package. If it is a compressed file, decompress it.
* Open Octave or Matlab command prompt.
Expand All @@ -31,13 +31,13 @@ To install (or test) the statistics-bootstrap package at it's existing location

Alternatively, users of more recent versions of Octave can install the package automatically with the following command:

`pkg install "https://github.com/gnu-octave/statistics-bootstrap/archive/refs/heads/master.zip"`
`pkg install "https://github.com/gnu-octave/statistics-resampling/archive/refs/heads/master.zip"`

The package can be loaded on demand in Octave with the following commmand:

`pkg load statistics-bootstrap`
`pkg load statistics-resampling`

In Octave, you can find out basic information about the package by typing: `pkg describe -verbose statistics-bootstrap`
In Octave, you can find out basic information about the package by typing: `pkg describe -verbose statistics-resampling`

## Usage

Expand All @@ -61,5 +61,3 @@ At the Octave/MATLAB command prompt, type `help function-name` for more informat
## Development roadmap


* We plan to rename the package to `statistics-resampling` to reflect the fact that this package also has functions that include forms of resampling that are not bootstrap (e.g. randomization)

6 changes: 3 additions & 3 deletions inst/bootci.m
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@
%! ## -------------------|--------|--------|--------|-------|
%! ## parametric - exact | 118.4 | 305.2 | 186.8 | 2.52 |
%!
%! ## Calculations using the 'statistics-bootstrap' package for Octave/Matlab
%! ## Calculations using the 'statistics-resampling' package for Octave/Matlab
%! ##
%! ## A = [48 36 20 29 42 42 20 42 22 41 45 14 6 ...
%! ## 0 33 28 34 4 32 24 47 41 24 26 30 41].';
Expand All @@ -604,7 +604,7 @@
%! ## ci6 = bootci (19999,{{@var,1},A},'alpha',0.1,'type','cal', ...
%! ## 'nbootcal',499,'seed',1);
%! ##
%! ## Summary of results from 'statistics-bootstrap' package for Octave/Matlab
%! ## Summary of results from 'statistics-resampling' package for Octave/Matlab
%! ##
%! ## method | 0.05 | 0.95 | length | shape |
%! ## -------------------|--------|--------|--------|-------|
Expand Down Expand Up @@ -776,4 +776,4 @@
%! assert (ci(1), 0.2832002889846569, 1e-07);
%! assert (ci(2), 0.9352503844648827, 1e-07);
%! end
%! ## Exact intervals based on normal theory are 0.51 - 0.91
%! ## Exact intervals based on normal theory are 0.51 - 0.91
2 changes: 1 addition & 1 deletion inst/bootclust.m
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
%
% REQUIREMENTS:
% The function file boot.m (or better boot.mex) and bootcdf, which are
% distributed with the statistics-bootstrap package.
% distributed with the statistics-resampling package.
%
% BIBLIOGRAPHY:
% [1] Hesterberg, Tim (2014), What Teachers Should Know about the
Expand Down
18 changes: 9 additions & 9 deletions inst/bootknife.m
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
%
% REQUIREMENTS:
% The function file boot.m (or better boot.mex) and bootcdf, which are
% distributed with the statistics-bootstrap package.
% distributed with the statistics-resampling package.
%
% DETAILS:
% For a DATA sample with n rows, bootknife resampling involves creating
Expand Down Expand Up @@ -1170,14 +1170,14 @@ function print_output (stats, nboot, alpha, l, m, bootfun_str, strata)
%! ## ci4 - percentile (resample) | 47.7 | 191.8 | 144.1 | 1.39 |
%! ## ci5 - expanded percentile (resample) | 41.1 | 209.0 | 167.9 | 1.51 |
%!
%! ## Calculations using the 'statistics-bootstrap' package for Octave/Matlab
%! ## Calculations using the 'statistics-resampling' package for Octave/Matlab
%! ##
%! ## x = [3 5 7 18 43 85 91 98 100 130 230 487]';
%! ## boot (1,1,false,1); ci3 = bootknife (x, 19999, @mean, [.025,.975]);
%! ## boot (1,1,false,1); ci5 = bootknife (x, 19999, @mean, 0.05);
%! ## boot (1,1,false,1); ci6 = bootknife (x, [19999,499], @mean, [.025,.975]);
%! ##
%! ## Confidence intervals from 'statistics-bootstrap' package for Octave/Matlab
%! ## Confidence intervals from 'statistics-resampling' package for Octave/Matlab
%! ##
%! ## method | 0.025 | 0.975 | length | shape |
%! ## --------------------------------------|--------|--------|--------|-------|
Expand Down Expand Up @@ -1303,7 +1303,7 @@ function print_output (stats, nboot, alpha, l, m, bootfun_str, strata)
%! ## -----------------------------------|----------|---------|----------------|
%! ## parametric - exact | 171.53 | -6.86 | 178.40 |
%!
%! ## Calculations using the 'statistics-bootstrap' package for Octave/Matlab
%! ## Calculations using the 'statistics-resampling' package for Octave/Matlab
%! ##
%! ## A = [48 36 20 29 42 42 20 42 22 41 45 14 6 ...
%! ## 0 33 28 34 4 32 24 47 41 24 26 30 41].';
Expand All @@ -1312,7 +1312,7 @@ function print_output (stats, nboot, alpha, l, m, bootfun_str, strata)
%! ## boot (1,1,false,1); ci6a = bootknife (A,[19999,499],{@var,1},0.1);
%! ## boot (1,1,false,1); ci6b = bootknife (A,[19999,499],{@var,1},[0.05,0.95]);
%! ##
%! ## Confidence intervals from 'statistics-bootstrap' package for Octave/Matlab
%! ## Confidence intervals from 'statistics-resampling' package for Octave/Matlab
%! ##
%! ## method | 0.05 | 0.95 | length | shape |
%! ## --------------------------------------|--------|--------|--------|-------|
Expand Down Expand Up @@ -1348,11 +1348,11 @@ function print_output (stats, nboot, alpha, l, m, bootfun_str, strata)
%! ## parametric - exact | 171.53 | -6.86 | 178.40 |
%!
%! ## The equivalent methods for constructing bootstrap intervals in the 'boot'
%! ## and 'bootstrap' packages (in R) and the statistics-bootstrap package (in
%! ## and 'bootstrap' packages (in R) and the statistics-resampling package (in
%! ## Octave/Matlab) produce intervals with very similar end points, length and
%! ## shape. However, all intervals calculated using the 'statistics-bootstrap'
%! ## shape. However, all intervals calculated using the 'statistics-resampling'
%! ## package are slightly longer than the equivalent intervals calculated in
%! ## R because the 'statistics-bootstrap' package uses bootknife resampling.
%! ## R because the 'statistics-resampling' package uses bootknife resampling.
%! ## The scale of the sampling distribution for small samples is approximated
%! ## better by bootknife (rather than bootstrap) resampling.

Expand Down Expand Up @@ -1572,4 +1572,4 @@ function print_output (stats, nboot, alpha, l, m, bootfun_str, strata)
%! assert (stats.CI_lower, 0.2078720903008157, 1e-08);
%! assert (stats.CI_upper, 0.9419996961228243, 1e-08);
%! end
%! ## Exact intervals based on normal theory are 0.51 - 0.91
%! ## Exact intervals based on normal theory are 0.51 - 0.91
4 changes: 2 additions & 2 deletions install.m
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
[fid, msg] = fopen (octaverc, 'w+t');
end
S = (fread (fid, '*char')).';
comment = sprintf ('\r\n\r\n%s', '% Load statistics-bootstrap package');
comment = sprintf ('\r\n\r\n%s', '% Load statistics-resampling package');
if isempty(strfind(S,comment))
S = strcat (S, comment);
end
Expand All @@ -46,7 +46,7 @@
end

% Notify user that installation is complete
disp ('The statistics-bootstrap package has been installed at the current location ')
disp ('The statistics-resampling package has been installed at the current location ')

% Clean up
clear info isoctave dirlist S comment i ii octaverc fid n msg
Expand Down
4 changes: 2 additions & 2 deletions uninstall.m
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
else
error('~/.octaverc does not exist');
end
comment = regexptranslate ('escape', '% Load statistics-bootstrap package');
comment = regexptranslate ('escape', '% Load statistics-resampling package');
S = regexprep(S,['\r\n\r\n',comment],'');
for i=1:n
S = regexprep(S,strcat('\r\n',...
Expand All @@ -48,7 +48,7 @@


% Notify user that uninstall is complete
disp ('This statistics-bootstrap package has been uninstalled from this location')
disp ('This statistics-resampling package has been uninstalled from this location')

% Clean up
clear info isoctave dirlist S comment i ii octaverc fid n msg
Expand Down

0 comments on commit fe06a1f

Please sign in to comment.