Skip to content

Update README.md to recommend pak for installation, and to cite the B… #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HorridTom merged 2 commits into from
Jan 29, 2026
Merged

Update README.md to recommend pak for installation, and to cite the B… #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1f4da0
Update README.md to recommend pak for installation, and to cite the B…
HorridTom Jan 29, 2026
bb26301
Increment version: 0.0.0.9045
HorridTom Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: autospc
Title: Automatically Partitioned SPC Charts
Version: 0.0.0.9044
Version: 0.0.0.9045
Authors@R: c(
person("Thomas", "Woodcock", , "woodcock.thomas@gmail.com", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-4735-4856")),
Expand Down
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,33 @@

autospc provides a rigorous and consistent means of re-establishing limits on
Shewhart charts (also known as control charts), using the
_Stable Shift Algorithm_.
_Stable Shift Algorithm_.<sup>1</sup>

The main function is `autospc()`, which plots Shewhart charts of various
types appropriate for different types of data, with limits established using the
algorithm.

## Installation

autospc can be installed using the [devtools](https://cran.r-project.org/web/packages/devtools/index.html) package.
autospc can be installed using the [pak](https://pak.r-lib.org/) package.

Install devtools if you have not already done so
Install pak if you have not already done so

`install.packages("devtools")`
`install.packages("pak")`

Then you can install autospc

`devtools::install_github("HorridTom/autospc")`
`pak::pkg_install("HorridTom/autospc")`

This may then give you the option to install other packages that `autospc` is
dependent on.

Note that you may need to install the necessary toolchains for building R
packages from source: [RTools](https://cran.r-project.org/bin/windows/Rtools/)
for Windows,
[Xcode and a Fortran compiler](https://cran.r-project.org/bin/macosx/tools/) for
Mac OS X.

Once installed, you can load autospc as usual with

`library(autospc)`
Expand Down Expand Up @@ -107,3 +113,11 @@ head(limits_table,
If you encounter a clear bug, please file an issue with a [minimal reproducible
example](https://forum.posit.co/t/faq-how-to-do-a-minimal-reproducible-example-reprex-for-beginners/23061)
on [GitHub](https://github.com/HorridTom/autospc/issues).

## References

1. Woodcock T, O’Connor I, Bell D. Re-establishing control limits in statistical
process control analyses: the stable shift algorithm. _BMJ Quality & Safety_
Published Online First: 30 November 2025.
doi: [10.1136/bmjqs-2025-019263](https://dx.doi.org/10.1136/bmjqs-2025-019263)