In AntonelliLab/outsider.devtools: Build 'outsider' Modules

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)

Run `%program_name%` with `outsider` in R

Summary line of what the program does.

Install and look up help

library(outsider)
module_install(repo = "%repo%")
module_help(repo = "%repo%")

A detailed example

library(outsider)
%cmd% <- module_import(fname = '%cmd%', repo = "%repo%")
%cmd%(arglist = c('--a', '-more=10', '-complicated=a', 'example.txt'))

module_uninstall(repo = "%repo%")

Key arguments

Describe key arguments and show program output. E.g. in table format.

|Argument|Usage|Description| |--------|-----|-----------| |a |--a |Runs "a" method| |more |-more=# |Run # more| |complicated|-complicated=[a-z]|Run [a-z]| |Output file|Final argument|Where to storeoutput|

Links

Find out more by visiting the %program_name%'s homepage.

Please cite

Smith, J. et al. (2020) %program_name% reference. Journal of Outsider Modules
Bennett et al. (2020). outsider: Install and run programs, outside of R, inside of R. Journal of Open Source Software, In review