Package 'fakemake'

Mock the Unix Make Utility

Description

Use R as a minimal build system. This might come in handy if you are developing R packages and can not use a proper build system. Stay away if you can (use a proper build system).

Details

You will find the details in
vignette("An_Introduction_to_fakemake", package = "fakemake").

---

Add a Target to a Makelist

Description

Add a target to an existing makelist.

Usage

add_target(
  makelist,
  target,
  code,
  prerequisites = NULL,
  prerequisite_to = NULL,
  sink = NULL,
  alias = sub("\\.(Rout|log)$", "", basename(target))
)

Arguments

makelist	A list for make.
target	The target to remove from makelist.
code	The code for the new target.
prerequisites	The prerequisites for the new target.
prerequisite_to	The targets the new target is a prerequisite to. Set to TRUE to add it as a prerequisite to all existing targets.
sink	The sink for the new target.
alias	The alias for the new target.

Value

A list for make.

See Also

Other functions to manipulate makelists: get_target(), remove_target()

---

Get a Makelist's Target

Description

Get a single target from a makelist by alias.

Usage

get_target(makelist, alias)

Arguments

makelist	A list for make.
alias	The alias of the target in question.

Value

A list (the target requested).

See Also

Other functions to manipulate makelists: add_target(), remove_target()

Examples

ml <- provide_make_list()
visualize(ml, root = "all.Rout")
i <- which(sapply(ml, "[[", "target") == "b1.Rout")
ml[[i]]["alias"] <- "b1"
t <- get_target(ml, "b1")
ml <- remove_target(ml, t[["target"]])
visualize(ml)
ml <- add_target(ml, target = t[["target"]], code = t[["code"]],
                sink = t[["sink"]],
                prerequisite_to = "a1.Rout", alias = NULL)
all.equal(ml, provide_make_list())

---

Mock the Unix Make Utility

Description

Mock the Unix Make Utility

Usage

make(
  name,
  make_list,
  force = FALSE,
  recursive = force,
  verbose = FALSE,
  verbosity = 2,
  dry_run = FALSE,
  unconditionally = FALSE,
  stop_on_warning = FALSE
)

Arguments

name	The name or alias of a make target.
make_list	The makelist (a listed version of a Makefile).
force	Force the target to be build? See Details.
recursive	Force the target to be build recursively? See Details.
verbose	Be verbose?
verbosity	Give the level of verbosity.
dry_run	Run dry? Mock GNU make's -n option.
unconditionally	Force the target's code to be evaluated unconditionally to any prerequisites? See Details.
stop_on_warning	Throw an error and abort if a recipe throws a warning?

Details

force, recursive
Forcing a target mocks adding .PHONY to a GNU Makefile if you set recursive to FALSE. If recursive is TRUE, then the whole make chain will be forced.

unconditionally
Setting unconditionally to TRUE allows you to fool make similarily to using GNU make's –touch option.

Value

Invisibly a character vector containing the targets made during the current run.

Examples

str(make_list <- provide_make_list("minimal"))
# build all
withr::with_dir(tempdir(), print(make("all.Rout", make_list)))
# nothing to be done
withr::with_dir(tempdir(), print(make("all.Rout", make_list)))
# forcing all.Rout
withr::with_dir(tempdir(), print(make("all.Rout", make_list, force = TRUE,
                                      recursive = FALSE)))
# forcing all.Rout recursively
withr::with_dir(tempdir(), print(make("all.Rout", make_list, force = TRUE))) 

# show files
dir(tempdir(), pattern = ".*\\.Rout")

# dry run
file.remove(dir(tempdir(), pattern = ".*\\.Rout", full.names = TRUE))
withr::with_dir(tempdir(), print(make("all.Rout", make_list,
                                      dry_run = TRUE)))
dir(tempdir(), pattern = ".*\\.Rout")

# make unconditionally
dir(tempdir(), pattern = ".*\\.Rout")
withr::with_dir(tempdir(), print(make("all.Rout", make_list,
                                      unconditionally = TRUE)))
dir(tempdir(), pattern = ".*\\.Rout")

---

Load an Example Makelist Provided by fakemake.

Description

Load an Example Makelist Provided by fakemake.

Usage

provide_make_list(
  type = c("minimal", "testing"),
  prune = TRUE,
  clean_sink = FALSE
)

Arguments

type	The type of makelist. package makelist.
prune	Prune the makelist of NULL items?
clean_sink	Remove sinks identical to corresponding targets from the list? Since makelists are parsed, missing sinks are set to the corresponding targets, but this makes them harder to read.

Value

A makelist.

Examples

str(provide_make_list("minimal"))
visualize(provide_make_list("minimal"))

---

Remove a Target From a Makelist

Description

Remove a target and all its appearances as other targets' dependencies from a makelist.

Usage

remove_target(makelist, target)

Arguments

makelist	A list for make.
target	The target to remove from makelist.

Value

A list for make.

See Also

Other functions to manipulate makelists: add_target(), get_target()

---

Visualize a Makelist

Description

Parse a makelist, convert it into an igraph and plot it.

Usage

visualize(make_list, root = NULL)

Arguments

make_list	The makelist.
root	The root of a tree.

Value

Invisibly an igraph representation of the makelist.

Examples

str(ml <- provide_make_list())
visualize(ml)
visualize(ml, root = "all.Rout")

---