Easily add logs to your functions.
Installation
You can install the development version of loud from GitHub with:
# install.packages("devtools")
devtools::install_github("b-rodrigues/loud@release_0.1.1")Example
This is a basic example which shows you how to solve a common problem:
library(loud)
loud_sqrt <- loudly(sqrt)
loud_sqrt(1:5)
#> $result
#> [1] 1.000000 1.414214 1.732051 2.000000 2.236068
#>
#> $log
#> [1] "Log start..."
#> [2] "✔ sqrt(1:5) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"You can also use the native R pipe:
loud_sqrt <- loudly(sqrt)
loud_exp <- loudly(exp)
loud_mean <- loudly(mean)
1:10 |>
loud_sqrt() |>
bind_loudly(loud_exp) |>
bind_loudly(loud_mean)
#> $result
#> [1] 11.55345
#>
#> $log
#> [1] "Log start..."
#> [2] "✔ sqrt(1:10) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [3] "✔ exp(.l$result) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [4] "✔ mean(.l$result) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"bind_loudly() is used to pass the output from one decorated function to the next.
loudly() works with any function:
library(dplyr)
#>
#> Attaching package: 'dplyr'
#> The following objects are masked from 'package:stats':
#>
#> filter, lag
#> The following objects are masked from 'package:base':
#>
#> intersect, setdiff, setequal, union
loud_group_by <- loudly(group_by)
loud_select <- loudly(select)
loud_summarise <- loudly(summarise)
loud_filter <- loudly(filter)
starwars %>%
loud_select(height, mass, species, sex) %>%
bind_loudly(loud_group_by, species, sex) %>%
bind_loudly(loud_filter, sex != "male") %>%
bind_loudly(loud_summarise,
mass = mean(mass, na.rm = TRUE)
)
#> $result
#> tibble [9, 3]
#> grouped by: species [9]
#> species chr Clawdite Droid Human Hutt Kaminoan Mirialan
#> sex chr female none female hermaphroditic female female
#> mass dbl 55 69.75 56.333333 1358 NaN 53.1
#>
#> $log
#> [1] "Log start..."
#> [2] "✔ select(.,height,mass,species,sex) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [3] "✔ group_by(.l$result,species,sex) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [4] "✔ filter(.l$result,sex != \"male\") started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [5] "✔ summarise(.l$result,mean(mass, na.rm = TRUE)) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"You could also use the %>=% pipe instead of bind_loudly():
starwars %>%
loud_value() %>=%
loud_select(height, mass, species, sex) %>=%
loud_group_by(species, sex) %>=%
loud_filter(sex != "male") %>=%
loud_summarise(mass = mean(mass, na.rm = TRUE))
#> $result
#> tibble [9, 3]
#> grouped by: species [9]
#> species chr Clawdite Droid Human Hutt Kaminoan Mirialan
#> sex chr female none female hermaphroditic female female
#> mass dbl 55 69.75 56.333333 1358 NaN 53.1
#>
#> $log
#> [1] "Created loud value..."
#> [2] "✔ select(.l$result,height,mass,species,sex) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [3] "✔ group_by(.l$result,species,sex) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [4] "✔ filter(.l$result,sex != \"male\") started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [5] "✔ summarise(.l$result,mean(mass, na.rm = TRUE)) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"Errors, warnings, and messages also get caught and composed in the log:
starwars %>%
loud_value() %>=%
loud_select(height, mass, species, sex) %>=%
loud_group_by(species, sx) %>=% # type, "sx" instead of "sex"
loud_filter(sex != "male") %>=%
loud_summarise(mass = mean(mass, na.rm = TRUE))
#> $result
#> NULL
#>
#> $log
#> [1] "Created loud value..."
#> [2] "✔ select(.l$result,height,mass,species,sex) started at 2022-03-16 21:11:42 and ended at 2022-03-16 21:11:42"
#> [3] "✖ CAUTION - ERROR: group_by(.l$result,species,sx) started at 2022-03-16 21:11:42 and failed at 2022-03-16 21:11:42 with following message: Must group by variables found in `.data`.\n✖ Column `sx` is not found."
#> [4] "✖ CAUTION - ERROR: filter(.l$result,sex != \"male\") started at 2022-03-16 21:11:42 and failed at 2022-03-16 21:11:42 with following message: no applicable method for 'filter' applied to an object of class \"NULL\""
#> [5] "✖ CAUTION - ERROR: summarise(.l$result,mean(mass, na.rm = TRUE)) started at 2022-03-16 21:11:42 and failed at 2022-03-16 21:11:42 with following message: no applicable method for 'summarise' applied to an object of class \"NULL\""