roxygen_text_to_doc: Clipboard To Doc

In selkamand/utilitybeltcli: What the Package Does (One Line, Title Case)

Clipboard To Doc

Description

Take roxygen comment + function copied to clipboard and produces draft docopt file contents. Add the following terms somewhere in your parameter descriptions to indicate their type:

Usage

roxygen_text_to_doc(roxygen_string = clipr::read_clip())

Arguments

roxygen_string

roxygen comments + described function (character). By default reads from clipboard.

Details

(flags) if boolean instead of arg (required) if argument/flag is not optional. eventually we want to automatically infer this from function definition

Value

returns the content for a docopt file (string). But usually run for its side effect (cat of docopt string)

selkamand/utilitybeltcli documentation built on July 30, 2022, 5:45 p.m.