Skip to contents

Build dataframe of functions for input to flashcard()

Usage

build_functions_df(file = NULL, fs = NULL, title, desc = TRUE)

Arguments

file

Character string of file name for text that includes code chunks. Can be local file or URL.

fs

If not using a file, character vector of functions [do not include ()].

title

Character string of title for flashcard deck (required)

desc

Logical for whether to search for descriptions from flashr_decks

Value

Dataframe suitable to include in flashcard().

Examples

build_functions_df(fs = c("apple", "apply", "+"), title = "Test")
#>      term                                                  description package
#> 1       +                                                     addition    base
#> 2 apple()                                                         <NA>    <NA>
#> 3 apply() apply a function to multiple elements of an object in base R    base
#>   title
#> 1  Test
#> 2  Test
#> 3  Test