errors
Uncertainty Propagation for R Vectors
Support for measurement errors in R vectors, matrices and arrays:
automatic uncertainty propagation and reporting.
Documentation about 'errors' is provided in the paper by Ucar, Pebesma &
Azcorra (2018,
The errors package provides support for easurement errors in R vectors, matrices and arrays: automatic uncertainty propagation and reporting.
Installation
Install the release version from CRAN:
install.packages("errors")
The installation from GitHub requires the remotes package.
# install.packages("remotes")remotes::install_github("r-quantities/errors")
Example
library(errors)x <- 1:10errors(x) <- 0.1x#> Errors: 0.1 0.1 0.1 0.1 0.1 ...#> [1] 1 2 3 4 5 6 7 8 9 10(x <- set_errors(1:10, 1:10 * 0.05))#> Errors: 0.05 0.10 0.15 0.20 0.25 ...#> [1] 1 2 3 4 5 6 7 8 9 10(df <- data.frame(x, 3*x, x^2, sin(x), cumsum(x)))#> Warning: In 'Ops' : non-'errors' operand automatically coerced to an#> 'errors' object with no uncertainty#> x X3...x x.2 sin.x. cumsum.x.#> 1 1.00(5) 3.0(2) 1.0(1) 0.84(3) 1.00(5)#> 2 2.0(1) 6.0(3) 4.0(4) 0.91(4) 3.0(1)#> 3 3.0(2) 9.0(5) 9.0(9) 0.1(1) 6.0(2)#> 4 4.0(2) 12.0(6) 16(2) -0.8(1) 10.0(3)#> 5 5.0(2) 15.0(8) 25(2) -0.96(7) 15.0(4)#> 6 6.0(3) 18.0(9) 36(4) -0.3(3) 21.0(5)#> 7 7.0(4) 21(1) 49(5) 0.7(3) 28.0(6)#> 8 8.0(4) 24(1) 64(6) 0.99(6) 36.0(7)#> 9 9.0(4) 27(1) 81(8) 0.4(4) 45.0(8)#> 10 10.0(5) 30(2) 100(10) -0.5(4) 55(1)format(df, notation="plus-minus")#> x X3...x x.2 sin.x. cumsum.x.#> 1 1.00 ± 0.05 3.0 ± 0.2 1.0 ± 0.1 0.84 ± 0.03 1.00 ± 0.05#> 2 2.0 ± 0.1 6.0 ± 0.3 4.0 ± 0.4 0.91 ± 0.04 3.0 ± 0.1#> 3 3.0 ± 0.2 9.0 ± 0.5 9.0 ± 0.9 0.1 ± 0.1 6.0 ± 0.2#> 4 4.0 ± 0.2 12.0 ± 0.6 16 ± 2 -0.8 ± 0.1 10.0 ± 0.3#> 5 5.0 ± 0.2 15.0 ± 0.8 25 ± 2 -0.96 ± 0.07 15.0 ± 0.4#> 6 6.0 ± 0.3 18.0 ± 0.9 36 ± 4 -0.3 ± 0.3 21.0 ± 0.5#> 7 7.0 ± 0.4 21 ± 1 49 ± 5 0.7 ± 0.3 28.0 ± 0.6#> 8 8.0 ± 0.4 24 ± 1 64 ± 6 0.99 ± 0.06 36.0 ± 0.7#> 9 9.0 ± 0.4 27 ± 1 81 ± 8 0.4 ± 0.4 45.0 ± 0.8#> 10 10.0 ± 0.5 30 ± 2 100 ± 10 -0.5 ± 0.4 55 ± 1sum(x)#> 55(1)print(mean(x), digits=3)#> 5.500(957)
News
errors 0.3.1
New features
- Add a new dataset from the Annex H of the Guide to the Expression of
Uncertainty in Measurement (GUM) and associated example (f6e5461, see
?GUM.H.3). - Provide methods for logical values to automatically reinterpret
NAasNA_real_(#30). - Add delayed S3 registration mechanism for R >= 3.6.0 (955e7ad).
Minor changes and fixes
- Move GUM examples to
?`errors-package`and provide new examples for?correl(aed40eb). - Simplify object ID handling (#27).
- Fix formatting in presence of missing values (as part of #30).
- Fix
Summary.errorsto deal with named arguments (dd4607b).
errors 0.3.0
New features
- Implement
as.listforerrorsobjects (7aff546). - Implement support for correlations between variables (#26). The
correlandcovarmethods set and retrieve pairwise correlations or covariances, respectively, betweenerrorsobjects, thereby completing the full first-order Taylor series method of propagation of uncertainty. - Add a new dataset from the Annex H of the Guide to the Expression of
Uncertainty in Measurement (GUM) (as part of #26; see
?GUM.H.2and examples under?correl). - Implement
all.equalforerrorsobjects (as part of #26), which returnsTRUEfor different (different internal identifier) objects with the same quantity values and uncertainty. To compare whether two variables are exactly the same object,identicalshould be used instead.
Minor changes and fixes:
- Fix encoding issues for the plus-minus symbol (#24).
- Fix
pillarrepresentation (14df89b). - Fix coercion issues (0e04519).
- Improve documentation (as part of #26).
errors 0.2.1
New features
- New
drop_errorsmethod dropserrorsclass and attributes. Equivalent to setting aNULLerror (#23). - Implement
pillar_shaftfor tidytibbleprinting and improvetype_sum(700f1aa).
Minor changes and fixes:
- Show
Opswarnings once (#22). - Refactor
printmethod (2c252d9). - Drop support for matrix multiplication: no warning is issued anymore (090e953).
- Fix
cbind/rbindcolumn/row name parsing for named arguments (b8ea6b5). - Improve plus-minus separator (8b3d231).
- Fix formatting to take into account the
scipenoption (9299551).
errors 0.2.0
Minor changes and fixes:
- Show a warning and drop errors in boolean operators instead of failing (#17).
min,max,rangereturn numeric, including the error: value minus error, value plus error and(min, max)respectively (#18).- Use
structureinstead ofset_errorsinternally (#20). - Improved support for matrices and data frames with the implementation of
rbind,cbind,as.data.frameforerrorsobjects (#21). - Improved documentation and testing (#19).
errors 0.1.0
Minor changes and fixes:
- Improved support for arrays and matrices (#4).
Inf,NaNandNAvalues default toInf,NaNandNAerrors respectively (#10).- Drop errors with a warning in matrix multiplication (#11).
- Fix errors defined as integers (#12).
- Do not allow boolean operators on
errorsobjects (#13). - Give a default value to
set_errors(#14). - Tidy
tibbleprinting (#15). - Correct plot limits according to error bars (#16).
errors 0.0.2
Minor changes and fixes:
- Fix exponentiation with negative base (#2).
- Fix formatting when the value equals zero (#3).
- Fix formatting when the error equals zero (#5).
- Take
digitsinto account for errors in vector display (#7). - Fix deletion of trailing zeroes in plus-minus notation (#8).