Skip to contents

Source: ../vignettes/articles/tinycodet.Rmd
tinycodet.Rmd

Introduction

The tinycodet R-package adds some functions to help in your coding etiquette. It primarily focuses on 4 aspects:

  1. Safer decimal (in)equality testing, standard-evaluated alternatives to with() and aes(), and other functions for safer coding.
  2. A new package import system, that attempts to combine the benefits of using a package without attaching, with the benefits of attaching a package.
  3. Extending the string manipulation capabilities of the stringi R package.
  4. Reducing repetitive code.

The tinycodet R-package has only one dependency, namely stringi. Most functions in this R-package are fully vectorized and optimized, and have been well documented.

Here I’ll give a quick glimpse of what is possible in this R package.

 

Safer functionality

‘tinycodet’ adds some functions to help in coding more safely:

  • In base R, (0.1*3) == 0.3 gives FALSE, due to the way decimal numbers are stored in programming languages like R and Python. tinycodet adds safer truth testing operators, that give correct results.
  • with_pro() and aes_pro() are standard-evaluated alternatives to base::with() and ggplot2::aes(). These use formulas as input.
  • One can re-assign the values T and F. One can even run T <- FALSE and F <- TRUE!. tinycodet adds the lock_TF() function that forces T to stay TRUE and F to stay FALSE.

One example with the %d==% operator:

x <- c(0.3, 0.6, 0.7)
y <- c(0.1*3, 0.1*6, 0.1*7)
print(x); print(y)
#> [1] 0.3 0.6 0.7
#> [1] 0.3 0.6 0.7

x == y # gives FALSE, but should be TRUE
#> [1] FALSE FALSE FALSE

x %d==% y # here it's done correctly
#> [1] TRUE TRUE TRUE

 

New import system

One can use a package without attaching the package (for example using ::), or one can attach a package (for example using library() or require()). The advantages and disadvantages of using without attaching a package versus attaching a package - at least those relevant for now - can be compactly presented in the following table:

aspect :: attach
1 prevent masking functions from other packages Yes (+) No (-)
2 prevent masking core R functions Yes (+) No (-)
3 clarify which function came from which package Yes (+) No (-)
4 place/expose functions only in current environment instead of globally Yes (+) No (-)
5 prevent namespace pollution Yes (+) No (-)
6 minimize typing - especially for infix operators
(i.e. typing package::`%op%`(x, y) instead of x %op% y is cumbersome) 		No (-) Yes (+)
7 use multiple related packages,
without constantly switching between package prefixes 		No (-) Yes (+)
NOTE: + = advantage, - = disadvantage

What tinycodet attempts to do with its import system, is to somewhat find the best of both worlds. It does this by introducing the following functions:

  • import_as(): Import a main package, and optionally its re-exports + its dependencies + its extensions, under a single alias. This essentially combines the attaching advantage of using multiple related packages (row 7 on the table above), whilst keeping most advantages of using without attaching a package.
  • import_inops(): Expose infix operators from a package or an alias object to the current environment. This gains the attaching advantage of less typing (row 6 in table above), whilst simultaneously avoiding the disadvantage of attaching functions from a package globally (row 4).
  • import_data(): Directly return a data set from a package, to allow straight-forward assignment.

Here is an example using tinycodet's new import system; note that the following code is run without attaching a single R package (besides tinycodet itself of course):

# importing "tidytable" + "data.table" under alias "tdt.":
import_as( 
  ~ tdt., "tidytable", dependencies = "data.table"
)
#> Importing packages and registering methods...
#> Done
#> You can now access the functions using `tdt.$`
#> For conflicts report, packages order, and other attributes, run `attr.import(tdt.)`

# exposing operators from `magrrittr` to current environment:
import_inops("magrittr")
#> Checking for conflicting infix operators in the current environment...
#> Placing infix operators in current environment...
#> Done

# directly assigning the "starwars" dataset to object "d":
d <- import_data("dplyr", "starwars") 

# see it in action:
d %>% tdt.$filter(species == "Droid") %>%
  tdt.$select(name, tdt.$ends_with("color"))
#> # A tidytable: 6 × 4
#>   name   hair_color skin_color  eye_color
#>   <chr>  <chr>      <chr>       <chr>    
#> 1 C-3PO  NA         gold        yellow   
#> 2 R2-D2  NA         white, blue red      
#> 3 R5-D4  NA         white, red  red      
#> 4 IG-88  none       metal       red      
#> 5 R4-P17 none       silver, red red, blue
#> 6 BB8    none       none        black

 

Extending the string manipulation capabilities of stringi 


# character vector:
x <- c("3rd 1st 2nd", "5th 4th 6th")
print(x)
#> [1] "3rd 1st 2nd" "5th 4th 6th"

# detect if there are digits:
x %s{}% "\\d"
#> [1] TRUE TRUE

# find second last digit:
loc <- stri_locate_ith(x, i = -2, regex = "\\d")
stringi::stri_sub(x, from = loc)
#> [1] "1" "4"

# cut x into matrix of individual words:
mat <- strcut_brk(x, "word")

# sort rows of matrix using the fast %row~% operator:
rank <- stringi::stri_rank(as.vector(mat)) |> matrix(ncol = ncol(mat))
sorted <- mat %row~% rank
sorted[is.na(sorted)] <- ""

# join elements of every row into a single character vector:
stri_c_mat(sorted, margin = 1, sep = " ")
#> [1] "    1st 2nd 3rd" "    4th 5th 6th"

 

Reduce repetitive code 

# in base R:
ifelse( # repetitive, and gives unnecessary warning
  is.na(object>0), -Inf,
  ifelse(
    object>0,  log(object), object^2
  )
)
mtcars$mpg[mtcars$cyl>6] <- (mtcars$mpg[mtcars$cyl>6])^2 # long

# with tinycodet:
object |> transform_if(\(x)x>0, log, \(x)x^2, \(x) -Inf) # compact & no warning
mtcars$mpg[mtcars$cyl>6] %:=% \(x)x^2 # short

 

The Articles

If you’re still interested, I invite you to read the articles on the website (https://tony-aw.github.io/tinycodet/), and perhaps try out the package yourself.

The following articles are currently present:

For a complete list of functions introduced by tinycodet, please see the References page.