Package: cmdfun 1.0.2

Spencer Nystrom

cmdfun: Framework for Building Interfaces to Shell Commands

Writing interfaces to command line software is cumbersome. 'cmdfun' provides a framework for building function calls to seamlessly interface with shell commands by allowing lazy evaluation of command line arguments. 'cmdfun' also provides methods for handling user-specific paths to tool installs or secrets like API keys. Its focus is to equally serve package builders who wish to wrap command line software, and to help analysts stay inside R when they might usually leave to execute non-R software.

Authors:Spencer Nystrom [aut, cre, cph]

cmdfun_1.0.2.tar.gz
cmdfun_1.0.2.zip(r-4.5)cmdfun_1.0.2.zip(r-4.4)cmdfun_1.0.2.zip(r-4.3)
cmdfun_1.0.2.tgz(r-4.4-any)cmdfun_1.0.2.tgz(r-4.3-any)
cmdfun_1.0.2.tar.gz(r-4.5-noble)cmdfun_1.0.2.tar.gz(r-4.4-noble)
cmdfun_1.0.2.tgz(r-4.4-emscripten)cmdfun_1.0.2.tgz(r-4.3-emscripten)
cmdfun.pdf |cmdfun.html✨
cmdfun/json (API)
NEWS

# Install 'cmdfun' in R:

install.packages('cmdfun', repos = c('https://snystrom.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/snystrom/cmdfun/issues

On CRAN:

5.83 score 15 stars 3 packages 6 scripts 459 downloads 21 exports 46 dependencies

Last updated 4 years agofrom:3aa798c65a. Checks:OK: 7. Indexed: yes.

Target	Result	Date
Doc / Vignettes	OK	Nov 22 2024
R-4.5-win	OK	Nov 22 2024
R-4.5-linux	OK	Nov 22 2024
R-4.4-win	OK	Nov 22 2024
R-4.4-mac	OK	Nov 22 2024
R-4.3-win	OK	Nov 22 2024
R-4.3-mac	OK	Nov 22 2024

Exports:.check_valid_command_path .check_valid_util cmd_args_all cmd_args_dots cmd_args_named cmd_error_if_missing cmd_file_combn cmd_file_expect cmd_help_flags_similar cmd_help_flags_suggest cmd_help_parse_flags cmd_install_check cmd_install_is_valid cmd_list_drop cmd_list_drop_named cmd_list_interp cmd_list_keep cmd_list_keep_named cmd_list_to_flags cmd_path_search cmd_ui_file_exists

Dependencies:askpass brio callr cli clipr crayon credentials curl desc diffobj digest evaluate fs gert gh gitcreds glue httr2 ini jsonlite lifecycle magrittr openssl pkgbuild pkgload praise processx ps purrr R.methodsS3 R.oo R.utils R6 rappdirs rlang rprojroot rstudioapi sys testthat usethis vctrs waldo whisker withr yaml zip

cmdfun

Rendered fromcmdfun.Rmdusingknitr::rmarkdownon Nov 22 2024.

Last update: 2020-10-02
Started: 2020-08-24

Help page	Topics
Checks path is valid	.check_valid_command_path
Checks for valid members of subdirectory	.check_valid_util
Return all named arguments and arguments passed as dots from parent function call	cmd_args_all
return function dots from parent function as named list	cmd_args_dots
Return all named arguments from parent function call	cmd_args_named
Check that file(s) exist, error if not	cmd_error_if_missing
Generates list of expected output files	cmd_file_combn
Creates list of paths by file extension & checks they exist	cmd_file_expect
Suggest alternative name by minimizing Levenshtein edit distance between valid and invalid arguments	cmd_help_flags_similar
Error & Suggest different flag name to user	cmd_help_flags_suggest
Parses commandline help options to return vector of valid flag names	cmd_help_parse_flags
Wrapper function for checking an install	cmd_install_check
Macro for constructing boolean check for valid path	cmd_install_is_valid
Drop entries from list of flags by name, name/value pair, or index	cmd_list_drop
Drop items by name from list	cmd_list_drop_named
Convert list of function arguments to list of command flags	cmd_list_interp
keep entries from list of flags by name, name/value pair, or index	cmd_list_keep
Keep items by name from list	cmd_list_keep_named
Convert flag list to vector of command flags	cmd_list_to_flags
Macro for constructing target path validators	cmd_path_search
Checks if file exists, returns pretty status message	cmd_ui_file_exists

Package: cmdfun 1.0.2

cmdfun: Framework for Building Interfaces to Shell Commands

cmdfun

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)