turbo: Wrapper constructor function to insert tidyverse functions at...

Description Usage Arguments Value Construct family

View source: R/turbo.R

Description

[Experimental]

turbo() is a wrapper for construct_* functions. It allows for rapid insertion of many popular functions living in different packages in a shorthand style, reducing time spent inputting and formatting code.

It has powerful side effect, which is its formula-like pipemath translation mechanism,with which entire pipelines are constructed and converted to dynamic snippets. See vignette("construct") for a list of combination functions. See superpipe for guide on constructing dynamic tidyverse snippets.

Abbreviations:

A leading digit indicates which package's function to insert. A digit is followed by a non-formatted series of first letters of snake_case segments, in order of appearance.

Default values:

Given default package options see vignette("set_x_default"), the leading digits refer to the following packages:

1 - searches for ggplot functions
2 - searches for stringr functions
3 - searches for forcats functions
4 - searches for clock functions
5 - searches for readr functions

Usage

1
turbo(input = NULL)

Arguments

input

optional character string to convert to script text at cursor location.

Value

A formatted function inserted at the cursor location

Construct family

The construct_* functions are intended to be called via a user-defined shortcut. There are three reasons for this:

  1. It allows for quick chaining of inputs

  2. Bypassing a library call at every session

  3. Bypass the need to put quotes around the call

In a specific use case, the construct_complex() function is synergistic with the superpipe operator


D-Se/turbokit documentation built on Dec. 17, 2021, 3:10 p.m.