README.md

In tomhopper/numbr: Utility functions for working with numbers

numbr

Convenience functions for working with numbers.

Installation

remotes::install_github("tomhopper/numbr")

Description

Provides functions missing in base R, including working with scientific notation and checking for integers.

is.int()

Determines if each element of a numeric vector fits the IEEE-754 definition of an integer that can be exactly represented with a double-precision number. This is different than the base R function is.integer(), which only checks if the numbers are stored as type integer.

x <- c(1, 412, 2.2)
is.int(x)

[1]  TRUE  TRUE FALSE

is.integer(x)

[1] FALSE

As of 0.8.0, now checks that x is of type numeric or integer, preventing an untrapped error when other (e.g. character) inputs are provided.

mantissa()

The mantissa function extracts the base-10 mantissa of a number, allowing further manipulation such as conversion to human-readable format.

exponent()

The exponent function extracts the base-10 exponent of a number, allowing further manipulation such as conversion to human-readable format.

decimal_places()

decimal_places returns the number of digits to the right of the decimal place for each element of a numeric vector.

%==%

x %==% y

Implements all.equal() ("(nearly) equal") for comparing two vectors on a row-by-row basis. Returns a logical vector of TRUE and FALSE values of the length of x indicating which rows are approximately equal and which are not. %==% has an advantage over == in that %==% will match numbers that are equal to within a defined tolerance (the defaults for all.equal()), whereas == will look for exact matches, without accounting for tolerance limits.

num_order_to_word()

The num_order_to_word function converts a number to its large number name representation using the so-called "short scale," in which the name changes with each increase by a power of 3. For example:

x <- c(323, 32423525, 86756456354)
num_order_to_word(x)

   number       name
1 3.2e+02        320
2 3.0e+07 30 million
3 9.0e+10 90 billion

mode_stat()

mode_stat returns the modal values of a given vector. It works with any type of vector.

mean_geom()

mean_geom calculates the geometric mean of a numeric or integer vector, returning a single value. The geometric mean, like the mean and the median, is an indication of the central tendancy of a set of numbers. The geometric mean is the nth root of the product of n numbers. For instance, the geometric mean of 2 and 8 is sqrt(2 * 8) = 4.

The geometric mean is useful when computing the central tendency of measures that have different ranges. For instance, when computing a single "figure of merit" from differentrating scales that have ranges 0 to 5 and 0 to 100.

area_hex()

area_hex returns the area of a hexagon given the apothem, or shorter radius, and/or the maximal radius (equal to the length of one of the sides).

model_fit_stats()

model_fit_stats accepts linear models and returns a data frame containing model fit statistics for each model, including adjusted R2, predictive R2, PRESS, AIC, and BIC statistics.

library(lme4)

m1_lm <- lm(mpg ~ disp + hp + drat + wt + qsec, data = mtcars)
m2_lm <- lm(mpg ~ disp + wt, data = mtcars)
m3_lm <- lm(mpg ~ hp + drat + qsec, data = mtcars)
m1_glm <- glm(mpg ~ disp + hp + wt, data = mtcars)
m1_lmer <- lmer(mpg ~ disp + hp + drat + wt + qsec + (1 | cyl) + (1 | gear), data = mtcars2)

model_fit_stats(m1_lm, m1_glm, m1_lmer, m2_lm, m3_lm)

   model terms     r.sqr adj.r.sqr pre.r.sqr    PRESS      AIC      BIC
1  m1_lm     5 0.8489147 0.8198599 0.7666213 262.7954 158.2784 168.5385
2 m1_glm     3        NA        NA        NA 261.3609 158.6430 165.9717
3  m2_lm     2 0.7809306 0.7658223 0.7253210 309.3015 164.1678 170.0307
4  m3_lm     3 0.7442512 0.7168495 0.6634817 378.9355 171.1216 178.4503
Warning message:
In model_fit_stats(m1_lm, m1_glm, m1_lmer, m2_lm, m3_lm) :
  Models m1_lmer are not of class 'lm' and will be excluded.

nCr()

Added as of 0.8.0.

Compute the number of possible combinations of n items, r at a time.

Calculates the number of arrangements in which no element occurs more than once and order does not matter, without the requirement of using all the elements from a given set. For example, if we were arranging an apple, a pear, and an orange (n = 3) into sets of two (r = 2), we would find that there are three possible combinations: an apple and a pear, an apple and an orange, and a pear and an orange. We would not count combinations where the order was reversed (e.g. a pear and an apple) as different combinations.

nPr()

Added as of 0.8.0

Calculate the number of possible partial permutations of n objects, r at a time.

Calculates the number of ordered arrangements in which no element occurs more than once, without the requirement of using all the elements from a given set. Also known as partial permutations or as sequences without repetition.

Changes

0.13.1 : Improved error handling, replacing class() checks with inherits() checks.

0.13.0 : Added significant_digits() and area_hex(). Cleaned up some error handling. Added a couple of unit tests.

0.12.1 : Improved error handling and added unit testing.

0.12.0 : nCr() and nPr() now return named vectors, with names identifying the n and r values. nCr and nPr also handle cases with n < r gracefully, returning NaN values in the vector.

0.11.1 : %==% now works when x and y are different lengths, recycling the shorter argument.

0.11.0 : added the %==% operator

0.10.1 : NA values on input now produce NA values in output for both number and name.

0.10.0 : Improves the handling of Inf, -Inf, and NA values, but may break code written for prior versions. Will now return Inf, "Inf"; -Inf, "-Inf"; and NA, "NA".

0.8.0 : Added nCr() and nPr()

tomhopper/numbr documentation built on Nov. 5, 2022, 11:35 p.m.