repo_build: Builds a resource using the associated code chunk

Description Usage Arguments Details Value

View source: R/repo_public.R

Description

In order to be buildable, a repository item must have an associated source file and code chunk.

Usage

1
2
3
4
5
6
7
8
repo_build(
  name,
  src = NULL,
  recursive = T,
  force = F,
  env = parent.frame(),
  built = list()
)

Arguments

name

Name of an item in the repo.

src

Path to a source file containing the code block associated with the resource. Not necessary if name is already in the repository and has an associated source item.

recursive

Build dependencies not already in the repo recursively (T by default).

force

Re-build dependencies recursively even if already in the repo (F by default).

env

Environment in which to run the code chunk associated with the item to build. Parent environment by default.

built

A list of items already built used for recursion (not meant to be passed directly).

Details

Code chunks are defined as in the following example: “' ## chunk "item 1" x <- code_to_make_x() rp$put(x, "item 1") ## “'

'item 1' must be associated to the source ('src' parameter of 'put') containing the chunk code.

Value

Nothing, used for side effects.


franapoli/repo documentation built on May 17, 2021, 7:24 p.m.