params

internal

Manage a collection/library of R source packages. Discover, document, load, test
source packages. Enable to use those packages as if they were actually installed. Quickly reload
only what is needed on source code change. Run tests and checks in parallel.

Karl Forner

srcpkgs

R Source Packages Manager

params function

<dl><dt>dry_run</dt>
<dd>whether not to actually execute any action having side-effects</dd>
<dt>lib</dt>
<dd>directory where to install and find installed pkgs</dd>
<dt>pkg</dt>
<dd>a package as a "srcpkg" object</dd>
<dt>pkgs</dt>
<dd>packages as a "srcpkgs" object</dd>
<dt>pkg_name</dt>
<dd>the package name, as a character</dd>
<dt>pkg_or_name</dt>
<dd>a package name or object ("package" or "srcpkg")</dd>
<dt>pkg_path</dt>
<dd>the package path, as a character</dd>
<dt>pkgid</dt>
<dd>a package name, path or package object</dd>
<dt>pkgids</dt>
<dd>a list of package ids (names, paths or object), or a
srcpkgs object. Also accept a singleton package object</dd>
<dt>md5</dt>
<dd>the MD5 hash of the source package</dd>
<dt>progress</dt>
<dd>whether to display a progress bar</dd>
<dt>roxygen</dt>
<dd>whether to roxygenize</dd>
<dt>src_pkgs</dt>
<dd>a collection of source packages as a <code>srckgs</code> object.</dd>
<dt>srcpkgs_paths</dt>
<dd>paths to the source packages folders</dd>
<dt>root</dt>
<dd>directory from where to search for source packages</dd>
<dt>quiet</dt>
<dd>whether to be quiet/silent</dd>
<dt>test_filter</dt>
<dd>a pattern to select the testthat tests to run.
Test files are names test-xxxxx.R where xxxxx is the
test name. Only test files whose name match the pattern
will be run.</dd>
<dt>test_parallel</dt>
<dd>whether to run the package tests in parallel</dd></dl>

Arguments

shared params — params

<dl>

<dt>dry_run</dt>
<dd>whether not to actually execute any action having side-effects</dd>


<dt>lib</dt>
<dd>directory where to install and find installed pkgs</dd>


<dt>pkg</dt>
<dd>a package as a "srcpkg" object</dd>


<dt>pkgs</dt>
<dd>packages as a "srcpkgs" object</dd>


<dt>pkg_name</dt>
<dd>the package name, as a character</dd>


<dt>pkg_or_name</dt>
<dd>a package name or object ("package" or "srcpkg")</dd>


<dt>pkg_path</dt>
<dd>the package path, as a character</dd>


<dt>pkgid</dt>
<dd>a package name, path or package object</dd>


<dt>pkgids</dt>
<dd>a list of package ids (names, paths or object), or a
srcpkgs object. Also accept a singleton package object</dd>


<dt>md5</dt>
<dd>the MD5 hash of the source package</dd>


<dt>progress</dt>
<dd>whether to display a progress bar</dd>


<dt>roxygen</dt>
<dd>whether to roxygenize</dd>


<dt>src_pkgs</dt>
<dd>a collection of source packages as a <code>srckgs</code> object.</dd>


<dt>srcpkgs_paths</dt>
<dd>paths to the source packages folders</dd>


<dt>root</dt>
<dd>directory from where to search for source packages</dd>


<dt>quiet</dt>
<dd>whether to be quiet/silent</dd>


<dt>test_filter</dt>
<dd>a pattern to select the testthat tests to run.
Test files are names test-xxxxx.R where xxxxx is the
test name. Only test files whose name match the pattern
will be run.</dd>


<dt>test_parallel</dt>
<dd>whether to run the package tests in parallel</dd>

</dl>

params: shared params

Description

Arguments