Create a "handle" for interacting with orderly repositories that
are hosted at a different path. This might be useful in cases
where you have access to an orderly repository via a network mount
or a synchronised folder (e.g., Dropbox, Box, etc). More
generally, orderly_remote_path implements an interface
used by orderly to abstract over different ways that orderly
repositories might be hosted remotely, including over HTTP APIs.
orderly_remote_path(path, name = NULL)
| path | Path to the orderly store |
|---|---|
| name | Name of the remote |
An orderly_remote_path object, with methods that
orderly will use in order to control this remote
orderly_pull_dependencies() and
orderly_pull_archive(), which are the primary ways
these remote objects are used. See also
OrderlyWeb for a
system for hosting orderly repositories over an HTTP API.
# Suppose we have a "remote" orderly repository at some path. # This might be read-only for you in practice and available via a # network filesystem or a dropbox folder synced to your computer. # We'll populate this with a pair of reports: path_remote <- orderly::orderly_example("demo") id <- orderly::orderly_run("other", list(nmin = 0), root = path_remote, echo = FALSE) #> [ name ] other #> [ id ] 20211125-140123-b22aa2b6 #> [ sources ] functions.R #> [ parameter ] nmin: 0 #> [ start ] 2021-11-25 14:01:23 #> [ data ] source => extract: 20 x 2 #> [ parameter ] nmin: 0 #> [ end ] 2021-11-25 14:01:23 #> [ elapsed ] Ran report in 0.01752234 secs #> [ artefact ] summary.csv: 3fac8347e152c84c96e6676413c718b7 #> [ ... ] graph.png: a70cdfd037035a0b34e71b921fc9de42 orderly::orderly_commit(id, root = path_remote) #> [ commit ] other/20211125-140123-b22aa2b6 #> [ copy ] #> [ import ] other:20211125-140123-b22aa2b6 #> [ success ] :) #> [1] "/tmp/RtmpP7mCov/file466f1d45c0/archive/other/20211125-140123-b22aa2b6" id <- orderly::orderly_run("use_dependency", root = path_remote, echo = FALSE) #> [ name ] use_dependency #> [ id ] 20211125-140123-ee8fd984 #> [ depends ] [email protected]:summary.csv -> incoming.csv #> [ start ] 2021-11-25 14:01:23 #> [ end ] 2021-11-25 14:01:23 #> [ elapsed ] Ran report in 0.01176929 secs #> [ artefact ] graph.png: a70cdfd037035a0b34e71b921fc9de42 #> [ ... ] info.rds: 7154587270d6f3f951fe9d15221f1e23 orderly::orderly_commit(id, root = path_remote) #> [ commit ] use_dependency/20211125-140123-ee8fd984 #> [ copy ] #> [ import ] use_dependency:20211125-140123-ee8fd984 #> [ success ] :) #> [1] "/tmp/RtmpP7mCov/file466f1d45c0/archive/use_dependency/20211125-140123-ee8fd984" # We'll create a an object to interact with this remote using # orderly_remote_path. remote <- orderly::orderly_remote_path(path_remote) # We can use this object directly remote$list_reports() #> [1] "changelog" "connection" "global" #> [4] "html" "interactive" "minimal" #> [7] "multi-artefact" "multifile-artefact" "other" #> [10] "slow1" "slow10" "slow3" #> [13] "spaces" "use_dependency" "use_dependency_2" #> [16] "use_resource" "use_resource_dir" "view" remote$list_versions("other") #> [1] "20211125-140123-b22aa2b6" # More typically one will interact with the functions # orderly_pull_archive and orderly_pull_dependencies. # Now, suppose that you have your "local" copy of this; it shares # the same source (ordinarily these would both be under version # control with git): path_local <- orderly::orderly_example("demo") # If we wanted to run the report "use_dependency" we need to have # a copy of the report "other", on which it depends: try(orderly::orderly_run("use_dependency", root = path_local)) #> [ name ] use_dependency #> Error in orderly_find_report(id, name, config, draft = use_draft, must_work = TRUE) : #> Did not find archive report other:latest # We can "pull" dependencies of a report before running orderly::orderly_pull_dependencies("use_dependency", remote = remote, root = path_local) #> [ depends ] use_dependency has 1 dependency #> [ pull ] other:20211125-140123-b22aa2b6 #> [ import ] other:20211125-140123-b22aa2b6 # Now we can run the report because we have a local copy of the # dependency: orderly::orderly_run("use_dependency", root = path_local) #> [ name ] use_dependency #> [ id ] 20211125-140124-4fff9412 #> [ depends ] [email protected]:summary.csv -> incoming.csv #> [ start ] 2021-11-25 14:01:24 #> #> > d <- read.csv("incoming.csv", stringsAsFactors = FALSE) #> #> > png("graph.png") #> #> > par(mar = c(15, 4, 0.5, 0.5)) #> #> > barplot(setNames(d$number, d$name), las = 2) #> #> > dev.off() #> agg_png #> 2 #> #> > info <- orderly::orderly_run_info() #> #> > saveRDS(info, "info.rds") #> [ end ] 2021-11-25 14:01:24 #> [ elapsed ] Ran report in 0.01268721 secs #> [ artefact ] graph.png: a70cdfd037035a0b34e71b921fc9de42 #> [ ... ] info.rds: 86227e4b74a3396236ba9e69c0558d39 #> [1] "20211125-140124-4fff9412" # We can also directly pull previously run reports: orderly::orderly_pull_archive("use_dependency", id, remote = remote, root = path_local) #> [ pull ] use_dependency:20211125-140123-ee8fd984 #> [ depends ] other/20211125-140123-b22aa2b6 #> [ pull ] other:20211125-140123-b22aa2b6 already exists, skipping #> [ import ] use_dependency:20211125-140123-ee8fd984 orderly::orderly_list_archive(root = path_local) #> name id #> 1 other 20211125-140123-b22aa2b6 #> 2 use_dependency 20211125-140123-ee8fd984