archive_export

0th

Percentile

Export remake contents

Export an archive of remake contents. Implicit files (those that remake does not generate) are not exported.

Usage
archive_export(target_names = NULL, dependencies = TRUE, verbose = TRUE,
  require_current = TRUE, allow_missing_packages = FALSE,
  archive_file = "remake.zip", remake_file = "remake.yml")
Arguments
target_names

Names of targets to export.

dependencies

Export the dependencies of target_names? The default is TRUE, which allows targets such as all to be specified in order to export everything that is a dependency of all. If dependencies is FALSE, all elements of target_names must represent files or objects.

verbose

Be verbose when reading the remake file?

require_current

Logical indicating if the targets must be up-to-date to be fetched. If this is TRUE and the targets are not up-to-date, then an error will be thrown.

allow_missing_packages

Allow missing packages when loading remake file?

archive_file

Name of the archive file to generate, by default remake.zip.

remake_file

Remake file to read, by default remake.yml.

Value

Invisibly, the name of the archive file generated. However, this function is primarily useful for its side effect, which is generating the archive.

Warning

The archive format is subject to change and is not suitable for long-term archiving. Moreover, it depends on R's internal rds format. This format is itself not guaranteed to stay constant, though it has for a long time now (see serialize()). However, this is likely to be reasonable for data interchange between computers or for short/medium term export of results. Until a lossless representation of all R objects exists, the rds problem is not likely to go away.

Aliases
  • archive_export
Documentation reproduced from package remake, version 0.3.0, License: BSD_2_clause + file LICENSE

Community examples

Looks like there are no examples yet.