- Remove environment locking, c.f. r-lib/rlang#1705.
- Export S3 methods.
- Avoid
memo_expr()
because it causes errors on R-devel.
- Avoid
is.R()
.
- Fix CRAN note.
- Fix test for CRAN.
- Migrate to the new interface in
clustermq
0.9.0 (@mschubert).
- Always pass a character vector to
rm()
andremove()
.
- Fix HTML documentation files.
- Improve error messages from static code analysis of malformed code (#1371, @billdenney).
- Handle invalid language objects in commands (#1372, @gorgitko).
- Do not lock namespaces (#1373, @gorgitko).
- Compatibility with
rlang
PR 1255.
- Update SLURM
batchtools
template file can be brewed (#1359, @pat-s). - Change start-up message to tip about
targets
.
- Add files
NOTICE
andinst/NOTICE
to more explicitly credit code included from other open source projects. (Previouslydrake
just had comments in the source with links to the various projects.)
- Avoid checking printed output in test of testing infrastructure.
- Use
dsl_sym()
instead ofas.symbol()
when constructing commands forcombine()
(#1340, @vkehayas).
- Add a new
level_separation
argument tovis_drake_graph()
andrender_drake_graph()
to control the aspect ratio ofvisNetwork
graphs (#1303, @matthewstrasiotto, @matthiasgomolka, @robitalec).
- Deprecate
caching = "master"
in favor ofcaching = "main"
. - Improve the error message when a valid plan is not supplied (#1334, @robitalec).
- Fix defunct functions error message when using namespace (#1310, @malcolmbarrett).
- Preserve names of list elements in
.data
in DSL (#1323, @shirdekel). - Use
identical()
to compare file hashes (#1324, @shirdekel). - Set
seed = TRUE
infuture::future()
. - Manually relay warnings when
parallelism = "clustermq"
andcaching = "worker"
(@richardbayes).
- Make logs more machine-readable by sanitizing messages and preventing race conditions (#1331, @Plebejer).
- Sanitize empty symbols in language columns (#1299, @odaniel1).
- Handle cases where
NROW()
throws an error (#1300,julian-tagell
on Stack Overflow). - Prohibit dynamic branching over non-branching dynamic files (#1302, @djbirke).
- Transition to updated
lifecycle
that does not require badges to be inman/figures
. - Improve error message for empty dynamic grouping variables (#1308, @saadaslam).
- Expose the
log_worker
argument ofclustermq::workers()
tomake()
anddrake_config()
(#1305, @billdenney, @mschubert). - Set
as.is
toTRUE
inutils::type.convert()
(#1309, @bbolker).
- Fix a CRAN warning about docs.
cached_planned()
andcached_unplanned()
now work with non-standard cache locations (#1268, @Plebejer).- Set
use_cache
toFALSE
more often (#1257, @Plebejer). - Use namespaced function calls in mtcars example instead of loading packages.
- Replace the
iris
dataset with theairquality
dataset in all documentation, examples, and tests (#1271). - Assign functions created with
code_to_function()
to the proper environment (#1275, @robitalec). - Store tracebacks as character vectors and restrict the contents of error objects to try to prevent accidental storage of large data from the environment (#1276, @billdenney).
- Strongly depend on
tidyselect
(#1274, @dernst). - Avoid
txtq
lockfiles (#1232, #1239, #1280, @danwwilson, @pydupont, @mattwarkentin).
- Add a new
drake_script()
function to write_drake.R
files forr_make()
(#1282).
- Deprecate
expose_imports()
in favor ofmake(envir = getNamespace("yourPackage")
(#1286, @mvarewyck). - Suppress the message recommending
r_make()
ifgetOption("drake_r_make_message")
isFALSE
(#1238, @januz). - Improve the appearance of the
visNetwork
graph by using the hierarchical layout withvisEdges(smooth = list(type = "cubicBezier", forceDirection = TRUE))
(#1289, @mstr3336).
- Invalidate old sub-targets when finalizing a dynamic target (@richardbayes). Solves a major reproducibility bug (#1260).
- Prevent
splice_inner()
from dropping formal arguments shared byc()
(#1262, @bart1).
- Repair
subtarget_hashes.cross()
for crosses on a single grouping variable. - Repair dynamic
group()
used with specialized formats (#1236, @adamaltmejd). - Enforce
tidyselect
>= 1.0.0.
- Allow user-defined target names in static branching with the
.names
argument (#1240, @maciejmotyka, @januz).
- Do not analyze dependencies of calls to
drake_plan()
(#1237, @januz). - Error message for locked cache gives paste-able error message in Windows (#1243, @billdenney).
- Prevent stack traces from accidentally storing large amounts of data (#1253, @sclewis23).
- Ensure up-to-date sub-targets are skipped even if the dynamic parent does not get a chance to finalize (#1209, #1211, @psadil, @kendonB).
- Restrict static transforms so they only use the upstream part of the plan (#1199, #1200, @bart1).
- Correctly match the names and values of dynamic
cross()
sub-targets (#1204, @psadil). Expansion order is the same, but names are correctly matched now. - Stop trying to remove
file_out()
files inclean()
, even whengarbage_collection
isTRUE
(#521, @the-Hull). - Fix
keep_going = TRUE
for formatted targets (#1206). - Use the correct variable names in logger helper (
progress_bar
instead ofprogress
) so thatdrake
works without theprogress
package (#1208, @mbaccou). - Avoid conflict between formats and upstream dynamic targets (#1210, @psadil).
- Always compute trigger metadata up front because recovery keys need it.
- Deprecate and remove hasty mode and custom parallel backends (#1222).
- Compartmentalize fixed runtime parameters in
config$settings
(#965).
- Add new functions
drake_done()
anddrake_cancelled()
(#1205).
- Avoid reading build times of dynamic sub-targets in
drake_graph_info()
(#1207).
- Show an empty progress bar just before targets start to build when
verbose
is2
(#1203, @kendonB). - Deprecate the
jobs
argument ofclean()
. - Show an informative error message for empty dynamic grouping variables (#1212, @kendonB).
- Throw error messages if users supply dynamic targets to
drake_build()
ordrake_debug()
(#1214, @kendonB). - Log the sub-target name and index of the failing sub-target in the metadata of the sub-target and its parent (#1214, @kendonB).
- Shorten the call stack in error metadata.
- Deprecate and remove custom schedulers (#1222).
- Deprecate
hasty_build
(#1222). - Migrate constant runtime parameters to
config$settings
(#965). - Warn the user if
file_in()
/file_out()
/knitr_in()
files are not literal strings (#1229). - Prohibit
file_out()
andknitr_in()
in imported functions (#1229). - Prohibit
knitr_in()
in dynamic branching (#1229). - Improve the help file of
target()
. - Deprecate and rename progress functions to avoid potential name conflicts (
progress()
=>drake_progress()
,running()
=>drake_running()
,failed()
=>drake_failed()
) (#1205).
- Sanitize internal S3 classes for target storage (#1159, @rsangole).
- Bump
digest
version to require 0.6.21 (#1166, @boshek) - Actually store output file sizes in metadata.
- Use the
depend
trigger to toggle invalidation from dynamic-only dependencies, including themax_expand
argument ofmake()
. - Repair
session_info
argument parsing (and reduce calls toutils::sessionInfo()
in tests). - Ensure compatibility with
tibble
3.0.0.
- Allow dynamic files with
target(format = "file")
(#1168, #1127). - Implement dynamic
max_expand
on a target-by-target basis viatarget()
(#1175, @kendonB).
- Assert dependencies of formats at the very beginning of
make()
, not indrake_config()
(#1156). - In
make(verbose = 2)
, remove the spinner and use a progress bar to track how many targets are done so far. - Reduce logging of utility functions.
- Improve the aesthetics of console messages using
cli
(optional package). - Deprecate
console_log_file
in favor oflog_make
as an argument tomake()
anddrake_config()
. - Immediately relay warnings and messages in
"loop"
and"future"
parallel backends (#400). - Warn when converting trailing dots (#1147).
- Warn about imports with trailing dots on Windows (#1147).
- Allow user-defined caches for the
loadd()
RStudio addin through the newrstudio_drake_cache
global option (#1169, @joelnitta). - Change dynamic target finalization message to "finalize" instead of "aggregate" (#1176, @kendonB).
- Describe the limits of
recoverable()
, e.g. dynamic branching + dynamic files. - Throw an error instead of a warning in
drake_plan()
if a grouping variable is undefined or invalid (#1182, @kendonB). - Rigorous S3 framework for static code analysis objects of type
drake_deps
anddrake_deps_ht
(#1183). - Use
rlang::trace_back()
to makediagnose()$error$calls
nicer (#1198).
These changes invalidate some targets in some workflows, but they are necessary bug fixes.
- Remove spurious local variables detected in
$<-()
and@<-()
(#1144). - Avoid target names with trailing dots (#1147, @Plebejer).
- Handle unequal list columns in
bind_plans()
(#1136, @jennysjaarda). - Handle non-vector sub-targets in dynamic branching (#1138).
- Handle calls in
analyze_assign()
(#1119, @jennysjaarda). - Restore correct environment locking (#1143, @kuriwaki).
- Log
"running"
progress of dynamic targets. - Log dynamic targets as failed if a sub-target fails (#1158).
- Add a new
"fst_tbl"
format for largetibble
targets (#1154, @kendonB). - Add a new
format
argument tomake()
, an optional custom storage format for targets without an explicittarget(format = ...)
in the plan (#1124). - Add a new
lock_cache
argument tomake()
to optionally suppress cache locking (#1129). (It can be annoying to interruptmake()
repeatedly and unlock the cache manually every time.) - Add new functions
cancel()
andcancel_if()
function to cancel targets mid-build (#1131). - Add a new
subtarget_list
argument toloadd()
andreadd()
to optionally load a dynamic target as a list of sub-targets (#1139, @MilesMcBain). - Prohibit dynamic
file_out()
(#1141).
- Check for illegal formats early on at the
drake_config()
level (#1156, @MilesMcBain). - Smoothly deprecate the
config
argument in all user-side functions (#1118, @vkehayas). Users can now supply the plan and othermake()
arguments directly, without bothering withdrake_config()
. Now, you only need to calldrake_config()
in the_drake.R
file forr_make()
and friends. Old code withconfig
objects should still work. Affected functions:make()
outdated()
drake_build()
drake_debug()
recoverable()
missed()
deps_target()
deps_profile()
drake_graph_info()
vis_drake_graph()
sankey_drake_graph()
drake_graph()
text_drake_graph()
predict_runtime()
. Needed to rename thetargets
argument totargets_predict
andjobs
tojobs_predict
.predict_workers()
. Same argument name changes aspredict_runtime()
.
- Because of #1118, the only remaining user-side purpose of
drake_config()
is to serve functionsr_make()
and friends. - Document the limitations of grouping variables (#1128).
- Handle the
@
operator. For example, in the static code analysis ofx@y
, do not registery
as a dependency (#1130, @famuvie). - Remove superfluous/incorrect information about imports from the output of
deps_profile()
(#1134, @kendonB). - Append hashes to
deps_target()
output (#1134, @kendonB). - Add S3 class and pretty print method for
drake_meta_()
objects objects. - Use call stacks instead of environment inheritance to power
drake_envir()
andid_chr()
(#1132). - Allow
drake_envir()
to select the environment with imports (#882). - Improve visualization labels for dynamic targets: clarify that the listed runtime is a total runtime over all sub-targets and list the number of sub-targets.
- Embrace the
vctrs
paradigm and its type stability for dynamic branching (#1105, #1106). - Accept
target
as a symbol by default inread_trace()
. Required for the trace to make sense in #1107.
- Repair reference to custom HPC resources in the
"future"
backend (#1083, @jennysjaarda). - Properly copy data when importing targets from one cache into another (#1120, @brendanf).
- Prevent dynamic vector sizes from conflicting with file sizes in metadata.
- Add a new
log_build_times
argument tomake()
anddrake_config()
. Allows users to disable the recording of build times. Produces a speedup of up to 20% on Macs (#1078). - Implement cache locking to prohibit concurrent calls to
make()
,outdated(make_imports = TRUE)
,recoverable(make_imports = TRUE)
,vis_drake_graph(make_imports = TRUE)
,clean()
, etc. on the same cache. - Add a new
format
trigger to invalidate targets when the specialized data format changes (#1104, @kendonB). - Add new functions
cache_planned()
andcache_unplanned()
to help selectively clean workflows with dynamic targets (#1110, @kendonB). - Add S3 classes and pretty print methods for
drake_config()
objects andanalyze_code()
objects. - Add a new
"qs"
format (#1121, @kendonB).
- Avoid setting seeds for imports (#1086, @adamkski).
- Avoid working directly with POSIXct times (#1086, @adamkski)
- Avoid excessive calls to
%||%
(%|||%
is faster). (#1089, @billdenney) - Remove
%||NA
due to slowness (#1089, @billdenney). - Use hash tables to speed up
is_dynamic()
andis_subtarget()
(#1089, @billdenney). - Use
getVDigest()
instead ofdigest()
(#1089, #1092, eddelbuettel/digest#139 (comment), @eddelbuettel, @billdenney). - Pre-compute
backtick
and.deparseOpts()
to speed updeparse()
(#1086,https://stackoverflow.com/users/516548/g-grothendieck
, @adamkski). - Pre-compute which targets exist in advance (#1095).
- Avoid gratuitous cache interactions and data frame operations in
build_times()
(#1098). - Use
mget_hash()
inprogress()
(#1098). - Get target progress info only once in
drake_graph_info()
(#1098). - Speed up the retrieval of old metadata in
outdated()
(#1098). - In
make()
, avoid checking for nonexistent metadata for missing targets. - Reduce logging in
drake_config()
.
- Write a complete project structure in
use_drake()
(#1097, @lorenzwalthert, @tjmahr). - Add a minor logger note to say how many dynamic sub-targets are registered at a time (#1102, @kendonB).
- Handle dependencies that are dynamic targets but not declared as such for the current target (#1107).
- Internally, the "layout" data structure is now called the "workflow specification", or "spec" for short. The spec is
drake
's interpretation of the plan. In the plan, all the dependency relationships among targets and files are implicit. In the spec, they are all explicit. We get from the plan to the spec using static code analysis, e.g.analyze_code()
.
- Prevent
drake::drake_plan(x = target(...))
from throwing an error ifdrake
is not loaded (#1039, @mstr3336). - Move the
transformations
lifecycle badge to the proper location in the docstring (#1040, @jeroen). - Prevent
readd()
/loadd()
from turning an imported function into a target (#1067). - Align in-memory
disk.frame
targets with their stored values (#1077, @brendanf).
- Implement dynamic branching (#685).
- Add a new
subtargets()
function to get the cached names of the sub-targets of a dynamic target. - Add new
subtargets
arguments toloadd()
andreadd()
to retrieve specific sub-targets from a parent dynamic target. - Add new
get_trace()
andread_trace()
functions to help track which values of grouping variables go into the making of dynamic sub-targets. - Add a new
id_chr()
function to get the name of the target whilemake()
is running. - Implement
plot(plan)
(#1036). vis_drake_graph()
,drake_graph_info()
, andrender_drake_graph()
now take arguments that allow behavior to be defined upon selection of nodes. (#1031,@mstr3336).- Add a new
max_expand
argument tomake()
anddrake_config()
to scale down dynamic branching (#1050, @hansvancalster).
- Document transformation functions in a way that avoids having to create true functions (#979).
- Avoid always invalidating the memoized layout when we set the knitr hash.
- Change the names of environments in
drake_config()
objects. - Assert that
prework
is a language object, list of language objects, or character vector (#1 at pat-s/multicore-debugging on GitHub, @pat-s). - Use an environment instead of a list for
config$layout
. Supports internal modifications by reference. Required for #685. - Clean up the code of the parallel backends.
- Make
dynamic
a formal argument oftarget()
. - Always lock/unlock the environment target by target, allowing informative error messages to appear more readily (#1062, @PedramNavid)
- Automatically ignore
storr
s and decoratedstorr
s (#1071). - Speed up memory management by avoiding a call to
setdiff()
and avoidingnames(config$envir_targets)
.
- Take the sum instead of the max in
dir_size()
. Incurs rehashing for some workflows, but should not invalidate any targets.
- Add a new
which_clean()
function to preview which targets will be invalidated byclean()
(#1014, @pat-s). - Add serious import and export methods for the decorated
storr
(#1015, @billdenney, @noamross). - Add a new
"diskframe"
format for larger-than-memory data (#1004, @xiaodaigh). - Add a new
drake_tempfile()
function to help with"diskframe"
format. It makes sure we are not copying large datasets across different physical storage media (#1004, @xiaodaigh). - Add new function
code_to_function()
to allow for parsing script based workflows into functions sodrake_plan()
can begin to manage the workflow and track dependencies. (#994, @thebioengineer)
- Coerce seeds to integers in
seed_trigger()
(#1013, @CreRecombinase). - Hard wrap long labels in graph visuals (#1017).
- Nest the history
txtq
API inside decoratedstorr
API (#1020). - Reduce cyclomatic complexity of internal functions.
- Reduce retrievals of old target metadata to try to improve performance (#1027).
- Remove README.md from CRAN altogether. Also remove all links from the news and vignette. The links trigger too many CRAN notes, which made the automated checks too brittle.
- Serialize formats that need serialization (like "keras") before sending the data from HPC workers to the main process (#989).
- Check for custom-formatted files when checking checksums.
- Force fst-formatted targets to plain data frames. Same goes for the new "fst_dt" format.
- Change the meaning and behavior of
max_expand
indrake_plan()
.max_expand
is now the maximum number of targets produced bymap()
,split()
, andcross()
. Forcross()
, this reduces the number of targets (less cumbersome) and makes the subsample of targets more representative of the complete grid. It also. ensures consistent target naming when.id
isFALSE
(#1002). Note:max_expand
is not for production workflows anyway, so this change does not break anything important. Unfortunately, we do lose the speed boost indrake_plan()
originally due tomax_expand
, butdrake_plan()
is still fast, so that is not so bad. - Drop specialized formats of
NULL
targets (#998). - Prevent false grouping variables from partially tagging along in
cross()
(#1009). The same fix should apply tomap()
andsplit()
too. - Respect graph topology when recovering old grouping variables for
map()
(#1010).
- Add a new "fst_dt" format for
fst
-powered saving ofdata.table
objects. - Support a custom "caching" column of the plan to select main vs worker caching for each target individually (#988).
- Make
transform
a formal argument oftarget()
so that users do not have to type "transform =" all the time indrake_plan()
(#993). - Migrate the documentation website from
ropensci.github.io/drake
todocs.ropensci.org/drake
.
- Document the HPC limitations of
target(format = "keras")
(#989). - Remove the now-superfluous vignette.
- Wrap up console and text file logging functionality into a reference class (#964).
- Deprecate the
verbose
argument in various caching functions. The location of the cache is now only printed inmake()
. This made the previous feature easier to implement. - Carry forward nested grouping variables in
combine()
(#1008). - Improve the encapsulation of hash tables in the decorated
storr
(#968).
- CRAN hotfix: remove a broken link in the README.
- Make
drake_plan(transform = slice())
understand.id
and grouping variables (#963). - Repair
clean(garbage_collection = TRUE, destroy = TRUE)
. Previously it destroyed the cache before trying to collect garbage. - Ensure that
r_make()
passes informative error messages back to the calling process (#969). - Avoid downloading full contents of URLs when rehashing (#982)
- Retain upstream grouping variables of
map()
andcross()
on topologically side-by-side targets (#983). - Manually enforce the correct ordering in
dsl_left_outer_join()
socross()
selects the right combinations of existing targets (#986). This bug was probably introduced in the solution to #983. - Make the output of
progress()
more consistent, less dependent on whethertidyselect
is installed.
- Support specialized data storage via a decorated cache and
format
argument oftarget()
(#971). This allows users to leverage faster ways to save and load targets, such aswrite_fst()
for data frames andsave_model_hdf5()
for Keras models. It also improves memory because it preventsstorr
from making a serialized in-memory copy of large data objects. - Add
tidyselect
functionality for...
inprogress()
, analogous toloadd()
,build_times()
, andclean()
. - Support S3 for user-defined generics (#959). If the generic
do_stuff()
and the methodstuff.your_class()
are defined inenvir
, and ifdo_stuff()
has a call toUseMethod("stuff")
, thendrake
's code analysis will detectstuff.your_class()
as a dependency ofdo_stuff()
. - Add authentication support for
file_in()
URLs. Requires the newcurl_handles
argument ofmake()
anddrake_config()
(#981).
- Document DSL keywords as if they were true functions:
target()
,map()
,split()
,cross()
, andcombine()
(#979). - Do garbage collection between the unloading and loading phases of memory management.
- Keep
file_out()
files inclean()
unlessgarbage_collection
isTRUE
. That way,make(recover = TRUE)
is a true "undo button" forclean()
.clean(garbage_collection = TRUE)
still removes data in the cache, as well as anyfile_out()
files from targets currently being cleaned. - The menu in
clean()
only appears ifgarbage_collection
isTRUE
. Also, this menu is added torescue_cache(garbage_collection = TRUE)
. - Reorganize the internal code files and functions to make development easier.
- Move the history inside the cache folder
.drake/
. The old.drake_history/
folder was awkward. Old histories are migrated duringdrake_config()
, anddrake_history()
. - Add lifecycle badges to exported functions.
- Eliminate accidental creations of
.drake_history
inplan_to_code()
,plan_to_notebook()
, and the examples in the help files.
- Change .drake_history$ to ^.drake_history$ in .Rbuildignore appease CRAN checks.
- Repair help file examples.
- Add automated data recovery (#945). This is still experimental and disabled by default. Requires
make(recover = TRUE)
. - Add new functions
recoverable()
andr_recoverable()
to show targets that are outdated but recoverable viamake(recover = TRUE)
. - Track the history and provenance of targets, viewable with
drake_history()
. Powered bytxtq
(#918, #920). - Add a new
no_deps()
function, similar toignore()
.no_deps()
suppresses dependency detection but still tracks changes to the literal code (#910). - Add a new "autoclean" memory strategy (#917).
- Export
transform_plan()
. - Allow a custom
seed
column ofdrake
plans to set custom seeds (#947). - Add a new
seed
trigger to optionally ignore changes to the target seed (#947).
- In
drake_plan()
, interpret custom columns as non-language objects (#942). - Suggest and assert
clustermq
>= 0.8.8. - Log the target name in a special column in the console log file (#909).
- Rename the "memory" memory strategy to "preclean" (with deprecation; #917).
- Deprecate
ensure_workers
indrake_config()
andmake()
. - Warn when the user supplies additional arguments to
make()
afterconfig
is already supplied. - Prevent users from running
make()
from inside the cache (#927). - Add
CITATION
file with JOSS paper. - In
deps_profile()
, include the seed and change the names. - Allow the user to set a different seed in
make()
. All this does is invalidate old targets. - Use
set_hash()
andget_hash()
instorr
to double the speed of progress tracking.
- In the static code analysis for dependency detection, ignore list elements referenced with
$
(#938). - Minor: handle strings embedded in language objects (#934).
- Minor: supply
xxhash64
as the default hash algorithm for non-storr
hashing if the driver does not have a hash algorithm.
These changes are technically breaking changes, but they should only affect advanced users.
rescue_cache()
no longer returns a value.
- Restore compatibility with
clustermq
(#898). Suggest version >= 0.8.8 but allow 0.8.7 as well. - Ensure
drake
recomputesconfig$layout
whenknitr
reports change (#887). - Do not rehash large imported files every
make()
(#878). - Repair parsing of long tidy eval inputs in the DSL (#878).
- Clear up cache confusion when a custom cache exists adjacent to the default cache (#883).
- Accept targets as symbols in
r_drake_build()
. - Log progress during
r_make()
(#889). - Repair
expose_imports()
: do not do theenvironment<-
trick unless the object is a non-primitive function. - Use different static analyses of
assign()
vsdelayedAssign()
. - Fix a superfluous code analysis warning incurred by multiple
file_in()
files and other strings (#896). - Make
ignore()
work insideloadd()
,readd()
,file_in()
,file_out()
, andknitr_in()
.
- Add experimental support for URLs in
file_in()
andfile_out()
.drake
now treatsfile_in()
/file_out()
files as URLS if they begin with "http://", "https://", or "ftp://". The fingerprint is a concatenation of the ETag and last-modified timestamp. If neither can be found or if there is no internet connection,drake
throws an error. - Implement new memory management strategies
"unload"
and"none"
, which do not attempt to load a target's dependencies from memory (#897). - Allow users to give each target its own memory strategy (#897).
- Add
drake_slice()
to help split data across multiple targets. Related: #77, #685, #833. - Introduce a new
drake_cache()
function, which is now recommended instead ofget_cache()
(#883). - Introduce a new
r_deps_target()
function. - Add RStudio addins for
r_make()
,r_vis_drake_graph()
, andr_outdated()
(#892).
- Deprecate
get_cache()
in favor ofdrake_cache()
. - Show the path to the cache in the
clean()
menu prompt. - Stop removing the console log file on each call to
drake_config()
. - Log the node name (short host name) and process ID in the console log file.
- Log the name of the calling function in the console log file, e.g. "begin make()" and "end make()". Applies to all functions that accept a
config
argument. - Memory management: set
use_cache
toFALSE
instorr
function calls for saving and loading targets. Also, at the end ofmake()
, callflush_cache()
(and thengc()
if garbage collection is enabled). - Mention
callr::r()
within commands as a safe alternative tolock_envir = FALSE
in the self-invalidation section of themake()
help file. - Use file size to help decide when to rehash
file_in()
/file_out()
/knitr_in()
files. We now rehash files if the file is less than 100 KB or the time stamp changed or the file size changed.
- Accommodate
rlang
's new interpolation operator{{
, which was causingmake()
to fail whendrake_plan()
commands are enclosed in curly braces (#864). - Move "
config$lock_envir <- FALSE
" fromloop_build()
tobackend_loop()
. This makes sureconfig$envir
is correctly locked inmake(parallelism = "clustermq")
. - Convert factors to characters in the optional
.data
argument ofmap()
andcross()
in the DSL. - In the DSL of
drake_plan()
, repaircross(.data = !!args)
, whereargs
is an optional data frame of grouping variables. - Handle trailing slashes in
file_in()
/file_out()
directories for Windows (#855). - Make
.id_chr
work withcombine()
in the DSL (#867). - Do not try
make_spinner()
unless the version ofcli
is at least 1.1.0.
- Add functions
text_drake_graph()
(andr_text_drake_graph()
andrender_text_drake_graph()
). Uses text art to print a dependency graph to the terminal window. Handy for when users SSH into remote machines without X Window support. - Add a new
max_expand
argument todrake_plan()
, an optional upper bound on the lengths of grouping variables formap()
andcross()
in the DSL. Comes in handy when you have a massive number of targets and you want to test on a miniature version of your workflow before you scale up to production.
- Delay the initialization of
clustermq
workers for as long as possible. Before launching them, build/check targets locally until we reach an outdated target withhpc
equal toFALSE
. In other words, if no targets actually requireclustermq
workers, no workers get created. - In
make(parallelism = "future")
, reset theconfig$sleep()
backoff interval whenever a new target gets checked. - Add a "done" message to the console log file when the workflow has completed.
- Replace
CodeDepends
with a base R solution incode_to_plan()
. Fixes a CRAN note. - The DSL (transformations in
drake_plan()
) is no longer experimental. - The
callr
API (r_make()
and friends) is no longer experimental. - Deprecate the wildcard/text-based functions for creating plans:
evaluate_plan()
,expand_plan()
,map_plan()
,gather_plan()
,gather_by()
,reduce_plan()
,reduce_by()
. - Change some deprecated functions to defunct:
deps()
,max_useful_jobs()
, andmigrate_drake_project()
.
- In the DSL (e.g.
drake_plan(x = target(..., transform = map(...)))
avoid inserting extra dots in target names when the grouping variables are character vectors (#847). Target names come out much nicer this way, but those name changes will invalidate some targets (i.e. they need to be rebuilt withmake()
).
- Use
config$jobs_preprocess
(local jobs) in several places wheredrake
was incorrectly usingconfig$jobs
(meant for targets). - Allow
loadd(x, deps = TRUE, config = your_config)
to work even ifx
is not cached (#830). Required disablingtidyselect
functionality whendeps
TRUE
. There is a new note in the help file about this, and an informative console message prints out onloadd(deps = TRUE, tidyselect = TRUE)
. The default value oftidyselect
is now!deps
. - Minor: avoid printing messages and warnings twice to the console (#829).
- Ensure compatibility with
testthat
>= 2.0.1.9000.
- In
drake_plan()
transformations, allow the user to refer to a target's own name using a special.id_chr
symbol, which is treated like a character string. - Add a
transparency
argument todrake_ggraph()
andrender_drake_ggraph()
to disable transparency in the rendered graph. Useful for R installations without transparency support.
- Use a custom layout to improve node positions and aspect ratios of
vis_drake_graph()
anddrake_ggraph()
displays. Only activated invis_drake_graph()
when there are at least 10 nodes distributed in both the vertical and horizontal directions. - Allow nodes to be dragged both vertically and horizontally in
vis_drake_graph()
andrender_drake_graph()
. - Prevent dots from showing up in target names when you supply grouping variables to transforms in
drake_plan()
(#847). - Do not keep
drake
plans (drake_plan()
) insidedrake_config()
objects. When other bottlenecks are removed, this will reduce the burden on memory (re #800). - Do not retain the
targets
argument insidedrake_config()
objects. This is to reduce memory consumption. - Deprecate the
layout
anddirection
arguments ofvis_drake_graph()
andrender_drake_graph()
. Direction is now always left to right and the layout is always Sugiyama. - Write the cache log file in CSV format (now
drake_cache.csv
by default) to avoid issues with spaces (e.g. entry names with spaces in them, such as "file report.Rmd")`.
- In
drake
7.0.0, if you runmake()
in interactive mode and respond to the menu prompt with an option other than1
or2
, targets will still build. - Make sure file outputs show up in
drake_graph()
. The bug came fromappend_output_file_nodes()
, a utility function ofdrake_graph_info()
. - Repair
r_make(r_fn = callr::r_bg())
re #799. - Allow
drake_ggraph()
andsankey_drake_graph()
to work when the graph has no edges.
- Add a new
use_drake()
function to write themake.R
and_drake.R
files from the "main example". Does not write other supporting scripts. - With an optional logical
hpc
column in yourdrake_plan()
, you can now select which targets to deploy to HPC and which to run locally. - Add a
list
argument tobuild_times()
, just likeloadd()
. - Add a new RStudio addin: 'loadd target at cursor' which can be bound a keyboard shortcut to load the target identified by the symbol at the cursor position to the global environment.
file_in()
andfile_out()
can now handle entire directories, e.g.file_in("your_folder_of_input_data_files")
andfile_out("directory_with_a_bunch_of_output_files")
.- Send less data from
config
to HPC workers. - Improve
drake_ggraph()
- Hide node labels by default and render the arrows behind the nodes.
- Print an informative error message when the user supplies a
drake
plan to theconfig
argument of a function. - By default, use gray arrows and a black-and-white background with no gridlines.
- For the
map()
andcross()
transformations in the DSL, prevent the accidental sorting of targets by name (#786). Neededmerge(sort = FALSE)
indsl_left_outer_join()
. - Simplify verbosity. The
verbose
argument ofmake()
now takes values 0, 1, and 2, and maximum verbosity in the console prints targets, retries, failures, and a spinner. The console log file, on the other hand, dumps maximally verbose runtime info regardless of theverbose
argument. - In previous versions, functions generated with
f <- Rcpp::cppFunction(...)
did not stay up to date from session to session because the addresses corresponding to anonymous pointers were showing up indeparse(f)
. Now,drake
ignores those pointers, andRcpp
functions compiled inline appear to stay up to date. This problem was more of an edge case than a bug. - Prepend time stamps with sub-second times to the lines of the console log file.
- In
drake_plan()
, deprecate thetidy_evaluation
argument in favor of the new and more concisetidy_eval
. To preserve back compatibility for now, if you supply a non-NULL
value totidy_evaluation
, it overwritestidy_eval
. - Reduce the object size of
drake_config()
objects by assigning closure ofconfig$sleep
tobaseenv()
.
- The enhancements that increase cache access speed also invalidate targets in old projects. Workflows built with drake <= 6.2.1 will need to run from scratch again.
- In
drake
plans, thecommand
andtrigger
columns are now lists of language objects instead of character vectors.make()
and friends still work if you have character columns, but the default output ofdrake_plan()
has changed to this new format. - All parallel backends (
parallelism
argument ofmake()
) except "clustermq" and "future" are removed. A new "loop" backend covers local serial execution. - A large amount of deprecated functionality is now defunct, including several functions (
built()
,find_project()
,imported()
, andparallel_stages()
; full list at #564) and the single-quoted file API. - Set the default value of
lock_envir
toTRUE
inmake()
anddrake_config()
. Somake()
will automatically quit in error if the act of building a target tries to change upstream dependencies. make()
no longer returns a value. Users will need to calldrake_config()
separately to get the old return value ofmake()
.- Require the
jobs
argument to be of length 1 (make()
anddrake_config()
). To parallelize the imports and other preprocessing steps, usejobs_preprocess
, also of length 1. - Get rid of the "kernels"
storr
namespace. As a result,drake
is faster, but users will no longer be able to load imported functions usingloadd()
orreadd()
. - In
target()
, users must now explicitly name all the arguments exceptcommand
, e.g.target(f(x), trigger = trigger(condition = TRUE))
instead oftarget(f(x), trigger(condition = TRUE))
. - Fail right away in
bind_plans()
when the result has duplicated target names. This makesdrake
's API more predictable and helps users catch malformed workflows earlier. loadd()
only loads targets listed in the plan. It no longer loads imports or file hashes.- The return values of
progress()
,deps_code()
,deps_target()
, andpredict_workers()
are now data frames. - Change the default value of
hover
toFALSE
in visualization functions. Improves speed.
- Allow
bind_plans()
to work with lists of plans (bind_plans(list(plan1, plan2))
was returningNULL
indrake
6.2.0 and 6.2.1). - Ensure that
get_cache(path = "non/default/path", search = FALSE)
looks for the cache in"non/default/path"
instead ofgetwd()
. - Remove strict dependencies on package
tibble
. - Pass the correct data structure to
ensure_loaded()
inmeta.R
andtriggers.R
when ensuring the dependencies of thecondition
andchange
triggers are loaded. - Require a
config
argument todrake_build()
andloadd(deps = TRUE)
.
- Introduce a new experimental domain-specific language for generating large plans (#233). Details in the "Plans" chapter of the manual.
- Implement a
lock_envir
argument to safeguard reproducibility. More discussion: #619, #620. - The new
from_plan()
function allows the users to reference custom plan columns from within commands. Changes to values in these columns columns do not invalidate targets. - Add a menu prompt (#762) to safeguard against
make()
pitfalls in interactive mode (#761). Appears once per session. Disable withoptions(drake_make_menu = FALSE)
. - Add new API functions
r_make()
,r_outdated()
, etc. to rundrake
functions more reproducibly in a clean session. See the help file ofr_make()
for details. progress()
gains aprogress
argument for filtering results. For example,progress(progress = "failed")
will report targets that failed.
- Large speed boost: move away from
storr
's key mangling in favor ofdrake
's own encoding of file paths and namespaced functions forstorr
keys. - Exclude symbols
.
,..
, and.gitignore
from being target names (consequence of the above). - Use only one hash algorithm per
drake
cache, which the user can set with thehash_algorithm
argument ofnew_cache()
,storr::storr_rds()
, and various other cache functions. Thus, the concepts of a "short hash algorithm" and "long hash algorithm" are deprecated, and the functionslong_hash()
,short_hash()
,default_long_hash_algo()
,default_short_hash_algo()
, andavailable_hash_algos()
are deprecated. Caches are still back-compatible withdrake
> 5.4.0 and <= 6.2.1. - Allow the
magrittr
dot symbol to appear in some commands sometimes. - Deprecate the
fetch_cache
argument in all functions. - Remove packages
DBI
andRSQLite
from "Suggests". - Define a special
config$eval <- new.env(parent = config$envir)
for storing built targets and evaluating commands in the plan. Now,make()
no longer modifies the user's environment. This move is a long-overdue step toward purity. - Remove dependency on the
codetools
package. - Deprecate and remove the
session
argument ofmake()
anddrake_config()
. Details: in #623. - Deprecate the
graph
andlayout
arguments tomake()
anddrake_config()
. The change simplifies the internals, and memoization allows us to do this. - Warn the user if running
make()
in a subdirectory of thedrake
project root (determined by the location of the.drake
folder in relation to the working directory). - In the code analysis, explicitly prohibit targets from being dependencies of imported functions.
- Increase options for the
verbose
argument, including the option to print execution and total build times. - Separate the building of targets from the processing of imports. Imports are processed with rudimentary staged parallelism (
mclapply()
orparLapply()
, depending on the operating system). - Ignore the imports when it comes to build times. Functions
build_times()
,predict_runtime()
, etc. focus on only the targets. - Deprecate many API functions, including
plan_analyses()
,plan_summaries()
,analysis_wildcard()
,cache_namespaces()
,cache_path()
,check_plan()
,dataset_wildcard()
,drake_meta()
,drake_palette()
,drake_tip()
,recover_cache()
,cleaned_namespaces()
,target_namespaces()
,read_drake_config()
,read_drake_graph()
, andread_drake_plan()
. - Deprecate
target()
as a user-side function. From now on, it should only be called from withindrake_plan()
. drake_envir()
now throws an error, not a warning, if called in the incorrect context. Should be called only inside commands in the user'sdrake
plan.- Replace
*expr*()
rlang
functions with their*quo*()
counterparts. We still keeprlang::expr()
in the few places where we know the expressions need to be evaluated inconfig$eval
. - The
prework
argument tomake()
anddrake_config()
can now be an expression (language object) or list of expressions. Character vectors are still acceptable. - At the end of
make()
, print messages about triggers etc. only ifverbose >= 2L
. - Deprecate and rename
in_progress()
torunning()
. - Deprecate and rename
knitr_deps()
todeps_knitr()
. - Deprecate and rename
dependency_profile()
todeps_profile()
. - Deprecate and rename
predict_load_balancing()
topredict_workers()
. - Deprecate
this_cache()
and defer toget_cache()
andstorr::storr_rds()
for simplicity. - Change the default value of
hover
toFALSE
in visualization functions. Improves speed. Also a breaking change. - Deprecate
drake_cache_log_file()
. We recommend usingmake()
with thecache_log_file
argument to create the cache log. This way ensures that the log is always up to date withmake()
results.
Version 6.2.1 is a hotfix to address the failing automated CRAN checks for 6.2.0. Chiefly, in CRAN's Debian R-devel (2018-12-10) check platform, errors of the form "length > 1 in coercion to logical" occurred when either argument to &&
or ||
was not of length 1 (e.g. nzchar(letters) && length(letters)
). In addition to fixing these errors, version 6.2.1 also removes a problematic link from the vignette.
- Add a
sep
argument togather_by()
,reduce_by()
,reduce_plan()
,evaluate_plan()
,expand_plan()
,plan_analyses()
, andplan_summaries()
. Allows the user to set the delimiter for generating new target names. - Expose a
hasty_build
argument tomake()
anddrake_config()
. Here, the user can set the function that builds targets in "hasty mode" (make(parallelism = "hasty")
). - Add a new
drake_envir()
function that returns the environment wheredrake
builds targets. Can only be accessed from inside the commands in the workflow plan data frame. The primary use case is to allow users to remove individual targets from memory at predetermined build steps.
- Ensure compatibility with
tibble
2.0.0. - Stop returning
0s
frompredict_runtime(targets_only = TRUE)
when some targets are outdated and others are not. - Remove
sort(NULL)
warnings fromcreate_drake_layout()
. (Affects R-3.3.x.)
- Remove strict dependencies on packages
evaluate
,formatR
,fs
,future
,parallel
,R.utils
,stats
, andstringi
. - Large speed boost: reduce repeated calls to
parse()
incode_dependencies()
. - Large speed boost: change the default value of
memory_strategy
(previouslypruning_strategy
) to"speed"
(previously"lookahead"
). - Compute a special data structure in
drake_config()
(config$layout
) just to store the code analysis results. This is an intermediate structure between the workflow plan data frame and the graph. It will help clean up the internals in future development. - Improve memoized preprocessing: deparse all the functions in the environment so the memoization does not react so spurious changes in R internals. Related: #345.
- Use the
label
argument tofuture()
insidemake(parallelism = "future")
. That way , job names are target names by default ifjob.name
is used correctly in thebatchtools
template file. - Remove strict dependencies on packages
dplyr
,evaluate
,fs
,future
,magrittr
,parallel
,R.utils
,stats
,stringi
,tidyselect
, andwithr
. - Remove package
rprojroot
from "Suggests". - Deprecate the
force
argument in all functions exceptmake()
anddrake_config()
. - Change the name of
prune_envir()
tomanage_memory()
. - Deprecate and rename the
pruning_strategy
argument tomemory_strategy
(make()
anddrake_config()
). - Print warnings and messages to the
console_log_file
in real time (#588). - Use HTML line breaks in
vis_drake_graph()
hover text to display commands in thedrake
plan more elegantly. - Speed up
predict_load_balancing()
and remove its reliance on internals that will go away in 2019 via #561. - Remove support for the
worker
column ofconfig$plan
inpredict_runtime()
andpredict_load_balancing()
. This functionality will go away in 2019 via #561. - Change the names of the return value of
predict_load_balancing()
totime
andworkers
. - Bring the documentation of
predict_runtime()
andpredict_load_balancing()
up to date. - Deprecate
drake_session()
and rename todrake_get_session_info()
. - Deprecate the
timeout
argument in the API ofmake()
anddrake_config()
. A value oftimeout
can be still passed to these functions without error, but only theelapsed
andcpu
arguments impose actual timeouts now.
- Add a new
map_plan()
function to easily create a workflow plan data frame to execute a function call over a grid of arguments. - Add a new
plan_to_code()
function to turndrake
plans into generic R scripts. New users can use this function to better understand the relationship between plans and code, and unsatisfied customers can use it to disentangle their projects fromdrake
altogether. Similarly,plan_to_notebook()
generates an R notebook from adrake
plan. - Add a new
drake_debug()
function to run a target's command in debug mode. Analogous todrake_build()
. - Add a
mode
argument totrigger()
to control how thecondition
trigger factors into the decision to build or skip a target. See the?trigger
for details. - Add a new
sleep
argument tomake()
anddrake_config()
to help the main process consume fewer resources during parallel processing. - Enable the
caching
argument for the"clustermq"
and"clustermq_staged"
parallel backends. Now,make(parallelism = "clustermq", caching = "main")
will do all the caching with the main process, andmake(parallelism = "clustermq", caching = "worker")
will do all the caching with the workers. The same is true forparallelism = "clustermq_staged"
. - Add a new
append
argument togather_plan()
,gather_by()
,reduce_plan()
, andreduce_by()
. Theappend
argument control whether the output includes the originalplan
in addition to the newly generated rows. - Add new functions
load_main_example()
,clean_main_example()
, andclean_mtcars_example()
. - Add a
filter
argument togather_by()
andreduce_by()
in order to restrict what we gather even whenappend
isTRUE
. - Add a hasty mode:
make(parallelism = "hasty")
skips all ofdrake
's expensive caching and checking. All targets run every single time and you are responsible for saving results to custom output files, but almost all the by-target overhead is gone.
- Ensure commands in the plan are re-analyzed for dependencies when new imports are added (#548). Was a bug in version 6.0.0 only.
- Call
path.expand()
on thefile
argument torender_drake_graph()
andrender_sankey_drake_graph()
. That way, tildes in file paths no longer interfere with the rendering of static image files. - Skip tests and examples if the required "Suggests" packages are not installed.
- Stop checking for non-standard columns. Previously, warnings about non-standard columns were incorrectly triggered by
evaluate_plan(trace = TRUE)
followed byexpand_plan()
,gather_plan()
,reduce_plan()
,gather_by()
, orreduce_by()
. The more relaxed behavior also gives users more options about how to construct and maintain their workflow plan data frames. - Use checksums in
"future"
parallelism to make sure files travel over network file systems before proceeding to downstream targets. - Refactor and clean up checksum code.
- Skip more tests and checks if the optional
visNetwork
package is not installed.
- Stop earlier in
make_targets()
if all the targets are already up to date. - Improve the documentation of the
seed
argument inmake()
anddrake_config()
. - Set the default
caching
argument ofmake()
anddrake_config()
to"main"
rather than"worker"
. The default option should be the lower-overhead option for small workflows. Users have the option to make a different set of tradeoffs for larger workflows. - Allow the
condition
trigger to evaluate to non-logical values as long as those values can be coerced to logicals. - Require that the
condition
trigger evaluate to a vector of length 1. - Keep non-standard columns in
drake_plan_source()
. make(verbose = 4)
now prints to the console when a target is stored.gather_by()
andreduce_by()
now gather/reduce everything if no columns are specified.- Change the default parallelization of the imports. Previously,
make(jobs = 4)
was equivalent tomake(jobs = c(imports = 4, targets = 4))
. Now,make(jobs = 4)
is equivalent tomake(jobs = c(imports = 1, targets = 4))
. See issue #553 for details. - Add a console message for building the priority queue when
verbose
is at least 2. - Condense
load_mtcars_example()
. - Deprecate the
hook
argument ofmake()
anddrake_config()
. - In
gather_by()
andreduce_by()
, do not exclude targets with allNA
gathering variables.
- Avoid serialization in
digest()
wherever possible. This puts olddrake
projects out of date, but it improves speed. - Require R version >= 3.3.0 rather than >= 3.2.0. Tests and checks still run fine on 3.3.0, but the required version of the
stringi
package no longer compiles on 3.2.0. - Be more discerning in detecting dependencies. In
code_dependencies()
, restrict the possible global variables to the ones mentioned in the newglobals
argument (turned off whenNULL
. In practical workflows, global dependencies are restricted to items inenvir
and proper targets in the plan. Indeps_code()
, theglobals
slot of the output list is now a list of candidate globals, not necessarily actual globals (some may not be targets or variables inenvir
).
- In the call to
unlink()
inclean()
, setrecursive
andforce
toFALSE
. This should prevent the accidental deletion of whole directories. - Previously,
clean()
deleted input-only files if no targets from the plan were cached. A patch and a unit test are included in this release. loadd(not_a_target)
no longer loads every target in the cache.- Exclude each target from its own dependency metadata in the "deps"
igraph
vertex attribute (fixes #503). - Detect inline code dependencies in
knitr_in()
file code chunks. - Remove more calls to
sort(NULL)
that caused warnings in R 3.3.3. - Fix a bug on R 3.3.3 where
analyze_loadd()
was sometimes quitting with "Error: attempt to set an attribute on NULL". - Do not call
digest::digest(file = TRUE)
on directories. Instead, set hashes of directories toNA
. Users should still not directories as file dependencies. - If files are declared as dependencies of custom triggers ("condition" and "change") include them in
vis_drake_graph()
. Previously, these files were missing from the visualization, but actual workflows worked just fine. - Work around mysterious
codetools
failures in R 3.3 (add atryCatch()
statement infind_globals()
).
- Add a proper
clustermq
-based parallel backend:make(parallelism = "clustermq")
. evaluate_plan(trace = TRUE)
now adds a*_from
column to show the origins of the evaluated targets. Tryevaluate_plan(drake_plan(x = rnorm(n__), y = rexp(n__)), wildcard = "n__", values = 1:2, trace = TRUE)
.- Add functions
gather_by()
andreduce_by()
, which gather on custom columns in the plan (or columns generated byevaluate_plan(trace = TRUE)
) and append the new targets to the previous plan. - Expose the
template
argument ofclustermq
functions (e.g.Q()
andworkers()
) as an argument ofmake()
anddrake_config()
. - Add a new
code_to_plan()
function to turn R scripts and R Markdown reports into workflow plan data frames. - Add a new
drake_plan_source()
function, which generates lines of code for adrake_plan()
call. Thisdrake_plan()
call produces the plan passed todrake_plan_source()
. The main purpose is visual inspection (we even have syntax highlighting viaprettycode
) but users may also save the output to a script file for the sake of reproducibility or simple reference. - Deprecate
deps_targets()
in favor of a newdeps_target()
function (singular) that behaves more likedeps_code()
.
- Smooth the edges in
vis_drake_graph()
andrender_drake_graph()
. - Make hover text slightly more readable in in
vis_drake_graph()
andrender_drake_graph()
. - Align hover text properly in
vis_drake_graph()
using the "title" node column. - Optionally collapse nodes into clusters with
vis_drake_graph(collapse = TRUE)
. - Improve
dependency_profile()
show major trigger hashes side-by-side to tell the user if the command, a dependency, an input file, or an output file changed since the lastmake()
. - Choose more appropriate places to check that the
txtq
package is installed. - Improve the help files of
loadd()
andreadd()
, giving specific usage guidance in prose. - Memoize all the steps of
build_drake_graph()
and print to the console the ones that execute. - Skip some tests if
txtq
is not installed.
- Overhaul the interface for triggers and add new trigger types ("condition" and "change").
- Offload
drake
's code examples to thedrake-examples
GitHub repository and make makedrake_example()
anddrake_examples()
download examples from there. - Optionally show output files in graph visualizations. See the
show_output_files
argument tovis_drake_graph()
and friends. - Repair output file checksum operations for distributed backends like
"clustermq_staged"
and"future_lapply"
. - Internally refactor the
igraph
attributes of the dependency graph to allow for smarter dependency/memory management duringmake()
. - Enable
vis_drake_graph()
andsankey_drake_graph()
to save static image files viawebshot
. - Deprecate
static_drake_graph()
andrender_static_drake_graph()
in favor ofdrake_ggraph()
andrender_drake_ggraph()
. - Add a
columns
argument toevaluate_plan()
so users can evaluate wildcards in columns other than thecommand
column ofplan
. - Name the arguments of
target()
so users do not have to (explicitly). - Lay the groundwork for a special pretty print method for workflow plan data frames.
- Allow multiple output files per command.
- Add Sankey diagram visuals:
sankey_drake_graph()
andrender_sankey_drake_graph()
. - Add
static_drake_graph()
andrender_static_drake_graph()
forggplot2
/ggraph
static graph visualizations. - Add
group
andclusters
arguments tovis_drake_graph()
,static_drake_graph()
, anddrake_graph_info()
to optionally condense nodes into clusters. - Implement a
trace
argument toevaluate_plan()
to optionally add indicator columns to show which targets got expanded/evaluated with which wildcard values. - Rename the
always_rename
argument torename
inevaluate_plan()
. - Add a
rename
argument toexpand_plan()
. - Implement
make(parallelism = "clustermq_staged")
, aclustermq
-based staged parallelism backend (see #452). - Implement
make(parallelism = "future_lapply_staged")
, afuture
-based staged parallelism backend (see #450). - Depend on
codetools
rather thanCodeDepends
for finding global variables. - Detect
loadd()
andreadd()
dependencies inknitr
reports referenced withknitr_in()
inside imported functions. Previously, this feature was only available in explicitknitr_in()
calls in commands. - Skip more tests on CRAN. White-list tests instead of blacklisting them in order to try to keep check time under the official 10-minute cap.
- Disallow wildcard names to grep-match other wildcard names or any replacement values. This will prevent careless mistakes and confusion when generating
drake_plan()
s. - Prevent persistent workers from hanging when a target fails.
- Move the example template files to
inst/hpc_template_files
. - Deprecate
drake_batchtools_tmpl_file()
in favor ofdrake_hpc_template_file()
anddrake_hpc_template_files()
. - Add a
garbage_collection
argument tomake()
. IfTRUE
,gc()
is called after every new build of a target. - Remove redundant calls to
sanitize_plan()
inmake()
. - Change
tracked()
to accept only adrake_config()
object as an argument. Yes, it is technically a breaking change, but it is only a small break, and it is the correct API choice. - Move visualization and hpc package dependencies to "Suggests:" rather than "Imports:" in the
DESCRIPTION
file. - Allow processing of codeless
knitr
reports without warnings.
- Skip several long-running and low-priority tests on CRAN.
- Sequester staged parallelism in backends "mclapply_staged" and "parLapply_staged". For the other
lapply
-like backends,drake
uses persistent workers and a main process. In the case of"future_lapply"
parallelism, the main process is a separate background process called byRscript
. - Remove the appearance of staged parallelism from single-job
make()
's. (Previously, there were "check" messages and a call tostaged_parallelism()
.) - Remove some remnants of staged parallelism internals.
- Allow different parallel backends for imports vs targets. For example,
make(parallelism = c(imports = "mclapply_staged", targets = "mclapply")
. - Fix a bug in environment pruning. Previously, dependencies of downstream targets were being dropped from memory in
make(jobs = 1)
. Now, they are kept in memory until no downstream target needs them (formake(jobs = 1)
). - Improve
predict_runtime()
. It is a more sensible way to go about predicting runtimes with multiple jobs. Likely to be more accurate. - Calls to
make()
no longer leave targets in the user's environment. - Attempt to fix a Solaris CRAN check error. A test was previously failing on CRAN's Solaris machine (R 3.5.0). In the test, one of the threads deliberately quits in error, and the R/Solaris installation did not handle this properly. The test should work now because it no longer uses any parallelism.
- Deprecate the
imports_only
argument tomake()
anddrake_config()
in favor ofskip_targets
. - Deprecate
migrate_drake_project()
. - Deprecate
max_useful_jobs()
. - For non-distributed parallel backends, stop waiting for all the imports to finish before the targets begin.
- Add an
upstream_only
argument tofailed()
so users can list failed targets that do not have any failed dependencies. Naturally accompaniesmake(keep_going = TRUE)
. - Add an RStudio R Markdown template.
- Remove
plyr
as a dependency. - Handle duplicated targets better in
drake_plan()
andbind_plans()
. - Add a true function
target()
to help create drake plans with custom columns. - In
drake_gc()
, clean out disruptive files instorr
s with mangled keys (re: #198). - Move all the vignettes to the up and coming user manual.
- Rename the "basic example" to the "mtcars example".
- Deprecate
load_basic_example()
in favor ofload_mtcars_example()
. - Refocus the
README.md
file on the main example rather than the mtcars example. - Use a
README.Rmd
file to generateREADME.md
. - Add function
deps_targets()
. - Deprecate function
deps()
in favor ofdeps_code()
- Add a
pruning_strategy
argument tomake()
anddrake_config()
so the user can decide howdrake
keeps non-import dependencies in memory when it builds a target. - Add optional custom (experimental) "workers" and "priorities" columns to the
drake
plans to help users customize scheduling. - Add a
makefile_path
argument tomake()
anddrake_config()
to avoid potential conflicts between user-side customMakefile
s and the one written bymake(parallelism = "Makefile")
. - Document batch mode for long workflows in the HPC guide.
- Add a
console
argument tomake()
anddrake_config()
so users can redirect console output to a file. - Make it easier for the user to find out where a target in the cache came from:
show_source()
,readd(show_source = TRUE)
,loadd(show_source = TRUE)
.
- In R 3.5.0, the
!!
operator from tidyeval andrlang
is parsed differently than in R <= 3.4.4. This change broke one of the tests intests/testthat/tidy-eval.R
The main purpose ofdrake
's 5.1.2 release is to fix the broken test. - Fix an elusive
R CMD check
error from building the pdf manual with LaTeX. - In
drake_plan()
, allow users to customize target-level columns usingtarget()
inside the commands. - Add a new
bind_plans()
function to concatenate the rows of drake plans and then sanitize the aggregate plan. - Add an optional
session
argument to tellmake()
to build targets in a separate, isolated main R session. For example,make(session = callr::r_vanilla)
.
- Add a
reduce_plan()
function to do pairwise reductions on collections of targets. - Forcibly exclude the dot (
.
) from being a dependency of any target or import. This enforces more consistent behavior in the face of the current static code analysis functionality, which sometimes detects.
and sometimes does not. - Use
ignore()
to optionally ignore pieces of workflow plan commands and/or imported functions. Useignore(some_code)
to- Force
drake
to not track dependencies insome_code
, and - Ignore any changes in
some_code
when it comes to deciding which target are out of date.
- Force
- Force
drake
to only look for imports in environments inheriting fromenvir
inmake()
(plus explicitly namespaced functions). - Force
loadd()
to ignore foreign imports (imports not explicitly found inenvir
whenmake()
last imported them). - Reduce default verbosity. Only targets are printed out by default. Verbosity levels are integers ranging from 0 through 4.
- Change
loadd()
so that only targets (not imports) are loaded if the...
andlist
arguments are empty. - Add check to drake_plan() to check for duplicate targets
- Add a
.gitignore
file containing"*"
to the default.drake/
cache folder every timenew_cache()
is called. This means the cache will not be automatically committed to git. Users need to remove.gitignore
file to allow unforced commits, and then subsequentmake()
s on the same cache will respect the user's wishes and not add another.gitignore
. this only works for the default cache. Not supported for manualstorr
s. - Add a new experimental
"future"
backend with a manual scheduler. - Implement
dplyr
-styletidyselect
functionality inloadd()
,clean()
, andbuild_times()
. Forbuild_times()
, there is an API change: fortidyselect
to work, we needed to insert a new...
argument as the first argument ofbuild_times()
. - Deprecate the single-quoting API for files. Users should now use formal API functions in their commands:
file_in()
for file inputs to commands or imported functions (for imported functions, the input file needs to be an imported file, not a target).file_out()
for output file targets (ignored if used in imported functions).knitr_in()
forknitr
/rmarkdown
reports. This tellsdrake
to look inside the source file for target dependencies in code chunks (explicitly referenced withloadd()
andreadd()
). Treated as afile_in()
if used in imported functions.
- Change
drake_plan()
so that it automatically fills in any target names that the user does not supply. Also, anyfile_out()
s become the target names automatically (double-quoted internally). - Make
read_drake_plan()
(rather than an emptydrake_plan()
) the defaultplan
argument in all functions that accept aplan
. - Add support for active bindings:
loadd(..., lazy = "bind")
. That way, when you have a target loaded in one R session and hitmake()
in another R session, the target in your first session will automatically update. - Use tibbles for workflow plan data frames and the output of
dataframes_graph()
. - Return warnings, errors, and other context of each build, all wrapped up with the usual metadata.
diagnose()
will take on the role of returning this metadata. - Deprecate the
read_drake_meta()
function in favor ofdiagnose()
. - Add a new
expose_imports()
function to optionally forcedrake
detect deeply nested functions inside specific packages. - Move the "quickstart.Rmd" vignette to "example-basic.Rmd". The so-called "quickstart" didn't end up being very quick, and it was all about the basic example anyway.
- Move
drake_build()
to be an exclusively user-side function. - Add a
replace
argument toloadd()
so that objects already in the user's environment need not be replaced. - When the graph cyclic, print out all the cycles.
- Prune self-referential loops (and duplicate edges) from the workflow graph. That way, recursive functions are allowed.
- Add a
seed
argument tomake()
,drake_config()
, andload_basic_example()
. Also hard-code a default seed of0
. That way, the pseudo-randomness in projects should be reproducible across R sessions. - Cache the pseudo-random seed at the time the project is created and use that seed to build targets until the cache is destroyed.
- Add a new
drake_read_seed()
function to read the seed from the cache. Its examples illustrate whatdrake
is doing to try to ensure reproducible random numbers. - Evaluate the quasiquotation operator
!!
for the...
argument todrake_plan()
. Suppress this behavior usingtidy_evaluation = FALSE
or by passing in commands passed through thelist
argument. - Preprocess workflow plan commands with
rlang::expr()
before evaluating them. That means you can use the quasiquotation operator!!
in your commands, andmake()
will evaluate them according to the tidy evaluation paradigm. - Restructure
drake_example("basic")
,drake_example("gsp")
, anddrake_example("packages")
to demonstrate how to set up the files for seriousdrake
projects. More guidance was needed in light of #193. - Improve the examples of
drake_plan()
in the help file (?drake_plan
).
- Transfer
drake
to rOpenSci GitHub URL. - Several functions now require an explicit
config
argument, which you can get fromdrake_config()
ormake()
. Examples:- outdated()
- missed()
- rate_limiting_times()
- predict_runtime()
- vis_drake_graph()
- dataframes_graph()
- Always process all the imports before building any targets. This is part of the solution to #168: if imports and targets are processed together, the full power of parallelism is taken away from the targets. Also, the way parallelism happens is now consistent for all parallel backends.
- Major speed improvement: dispense with internal inventories and rely on
cache$exists()
instead. - Let the user define a trigger for each target to customize when
make()
decides to build targets. - Document triggers and other debugging/testing tools in the new "debug" vignette.
- Restructure the internals of the
storr
cache in a way that is not back-compatible with projects from versions 4.4.0 and earlier. The main change is to make more intelligent use ofstorr
namespaces, improving efficiency (both time and storage) and opening up possibilities for new features. If you attempt to run drake >= 5.0.0 on a project from drake <= 4.0.0, drake will stop you before any damage to the cache is done, and you will be instructed how to migrate your project to the new drake. - Use
formatR::tidy_source()
instead ofparse()
intidy_command()
(originallytidy()
inR/dependencies.R
). Previously,drake
was having problems with an edge case: as a command, the literal string"A"
was interpreted as the symbolA
after tidying. Withtidy_source()
, literal quoted strings stay literal quoted strings in commands. This may put some targets out of date in old projects, yet another loss of back compatibility in version 5.0.0. - Speed up clean() by refactoring the cache inventory and using light parallelism.
- Implement
rescue_cache()
, exposed to the user and used inclean()
. This function removes dangling orphaned files in the cache so that a broken cache can be cleaned and used in the usual ways once more. - Change the default
cpu
andelapsed
arguments ofmake()
toNULL
. This solves an elusive bug in how drake imposes timeouts. - Allow users to set target-level timeouts (overall, cpu, and elapsed) with columns in the workflow plan data frame.
- Document timeouts and retries in the new "debug" vignette.
- Add a new
graph
argument to functionsmake()
,outdated()
, andmissed()
. - Export a new
prune_graph()
function for igraph objects. - Delete long-deprecated functions
prune()
andstatus()
. - Deprecate and rename functions:
analyses()
=>plan_analyses()
as_file()
=>as_drake_filename()
backend()
=>future::plan()
build_graph()
=>build_drake_graph()
check()
=>check_plan()
config()
=>drake_config()
evaluate()
=>evaluate_plan()
example_drake()
=>drake_example()
examples_drake()
=>drake_examples()
expand()
=>expand_plan()
gather()
=>gather_plan()
plan()
,workflow()
,workplan()
=>drake_plan()
plot_graph()
=>vis_drake_graph()
read_config()
=>read_drake_config()
read_graph()
=>read_drake_graph()
read_plan()
=>read_drake_plan()
render_graph()
=>render_drake_graph()
session()
=>drake_session()
summaries()
=>plan_summaries()
- Disallow
output
andcode
as names in the workflow plan data frame. Usetarget
andcommand
instead. This naming switch has been formally deprecated for several months prior. - Deprecate the ..analysis.. and ..dataset.. wildcards in favor of analysis__ and dataset__, respectively. The new wildcards are stylistically better an pass linting checks.
- Add new functions
drake_quotes()
,drake_unquote()
, anddrake_strings()
to remove the silly dependence on theeply
package. - Add a
skip_safety_checks
flag tomake()
anddrake_config()
. Increases speed. - In
sanitize_plan()
, remove rows with blank targets "". - Add a
purge
argument toclean()
to optionally remove all target-level information. - Add a
namespace
argument tocached()
so users can inspect individualstorr
namespaces. - Change
verbose
to numeric: 0 = print nothing, 1 = print progress on imports only, 2 = print everything. - Add a new
next_stage()
function to report the targets to be made in the next parallelizable stage. - Add a new
session_info
argument tomake()
. Apparently,sessionInfo()
is a bottleneck for smallmake()
s, so there is now an option to suppress it. This is mostly for the sake of speeding up unit tests. - Add a new
log_progress
argument tomake()
to suppress progress logging. This increases storage efficiency and speeds some projects up a tiny bit. - Add an optional
namespace
argument toloadd()
andreadd()
. You can now load and read from non-defaultstorr
namespaces. - Add
drake_cache_log()
,drake_cache_log_file()
, andmake(..., cache_log_file = TRUE)
as options to track changes to targets/imports in the drake cache. - Detect knitr code chunk dependencies in response to commands with
rmarkdown::render()
, not justknit()
. - Add a new general best practices vignette to clear up misconceptions about how to use
drake
properly.
- Extend
plot_graph()
to display subcomponents. Check out argumentsfrom
,mode
,order
, andsubset
. The graph visualization vignette has demonstrations. - Add
"future_lapply"
parallelism: parallel backends supported by thefuture
andfuture.batchtools
packages. See?backend
for examples and the parallelism vignette for an introductory tutorial. More advanced instruction can be found in thefuture
andfuture.batchtools
packages themselves. - Cache diagnostic information of targets that fail and retrieve diagnostic info with
diagnose()
. - Add an optional
hook
argument tomake()
to wrap aroundbuild()
. That way, users can more easily control the side effects of distributed jobs. For example, to redirect error messages to a file inmake(..., parallelism = "Makefile", jobs = 2, hook = my_hook)
,my_hook
should be something likefunction(code){withr::with_message_sink("messages.txt", code)}
. - Remove console logging for "parLapply" parallelism.
drake
was previously using theoutfile
argument for PSOCK clusters to generate output that could not be caught bycapture.output()
. It was a hack that should have been removed before. - Remove console logging for "parLapply" parallelism.
drake
was previously using theoutfile
argument for PSOCK clusters to generate output that could not be caught bycapture.output()
. It was a hack that should have been removed before. - If 'verbose' is 'TRUE' and all targets are already up to date (nothing to build), then
make()
andoutdated()
print "All targets are already up to date" to the console. - Add new examples in 'inst/examples', most of them demonstrating how to use the
"future_lapply"
backends. - New support for timeouts and retries when it comes to building targets.
- Failed targets are now recorded during the build process. You can see them in
plot_graph()
andprogress()
. Also see the newfailed()
function, which is similar toin_progress()
. - Speed up the overhead of
parLapply
parallelism. The downside to this fix is thatdrake
has to be properly installed. It should not be loaded withdevtools::load_all()
. The speedup comes from lightening the firstclusterExport()
call inrun_parLapply()
. Previously, we exported every single individualdrake
function to all the workers, which created a bottleneck. Now, we just loaddrake
itself in each of the workers, which works becausebuild()
anddo_prework()
are exported. - Change default value of
overwrite
toFALSE
inload_basic_example()
. - Warn when overwriting an existing
report.Rmd
inload_basic_example()
. - Tell the user the location of the cache using a console message. Happens on every call to
get_cache(..., verbose = TRUE)
. - Increase efficiency of internal preprocessing via
lightly_parallelize()
andlightly_parallelize_atomic()
. Now, processing happens faster, and only over the unique values of a vector. - Add a new
make_with_config()
function to do the work ofmake()
on an existing internal configuration list fromdrake_config()
. - Add a new function
drake_batchtools_tmpl_file()
to write abatchtools
template file from one of the examples (drake_example()
), if one exists.
Version 4.3.0 has:
- Reproducible random numbers (#56)
- Automatic detection of knitr dependencies (#9)
- More vignettes
- Bug fixes
Version 4.2.0 will be released today. There are several improvements to code style and performance. In addition, there are new features such as cache/hash externalization and runtime prediction. See the new storage and timing vignettes for details. This release has automated checks for back-compatibility with existing projects, and I also did manual back compatibility checks on serious projects.
Version 3.0.0 is coming out. It manages environments more intelligently so that the behavior of make()
is more consistent with evaluating your code in an interactive session.
Version 1.0.1 is on CRAN! I'm already working on a massive update, though. 2.0.0 is cleaner and more powerful.