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.
Value
An orderly_remote_path object, with methods that
orderly will use in order to control this remote
See also
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.
Examples
# 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 ] 20221116-140036-7e157edf
#> [ sources ] functions.R
#> [ parameter ] nmin: 0
#> [ start ] 2022-11-16 14:00:36
#> [ data ] source => extract: 20 x 2
#> [ parameter ] nmin: 0
#> [ end ] 2022-11-16 14:00:36
#> [ elapsed ] Ran report in 0.01965618 secs
#> [ artefact ] summary.csv: 3fac8347e152c84c96e6676413c718b7
#> [ ... ] graph.png: a70cdfd037035a0b34e71b921fc9de42
orderly::orderly_commit(id, root = path_remote)
#> [ commit ] other/20221116-140036-7e157edf
#> [ copy ]
#> [ import ] other:20221116-140036-7e157edf
#> [ success ] :)
#> [1] "/tmp/Rtmpj7MjPt/file462caaf6f7/archive/other/20221116-140036-7e157edf"
id <- orderly::orderly_run("use_dependency",
root = path_remote, echo = FALSE)
#> [ name ] use_dependency
#> [ id ] 20221116-140036-c7fc695e
#> [ depends ] [email protected]:summary.csv -> incoming.csv
#> [ start ] 2022-11-16 14:00:36
#> [ end ] 2022-11-16 14:00:36
#> [ elapsed ] Ran report in 0.01317167 secs
#> [ artefact ] graph.png: a70cdfd037035a0b34e71b921fc9de42
#> [ ... ] info.rds: 1b54056b8620fd5b3702815e6dafd0e2
orderly::orderly_commit(id, root = path_remote)
#> [ commit ] use_dependency/20221116-140036-c7fc695e
#> [ copy ]
#> [ import ] use_dependency:20221116-140036-c7fc695e
#> [ success ] :)
#> [1] "/tmp/Rtmpj7MjPt/file462caaf6f7/archive/use_dependency/20221116-140036-c7fc695e"
# 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" "default-param"
#> [4] "global" "html" "interactive"
#> [7] "minimal" "multi-artefact" "multifile-artefact"
#> [10] "other" "slow1" "slow10"
#> [13] "slow3" "spaces" "use_dependency"
#> [16] "use_dependency_2" "use_resource" "use_resource_dir"
#> [19] "view"
remote$list_versions("other")
#> [1] "20221116-140036-7e157edf"
# 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:20221116-140036-7e157edf
#> [ import ] other:20221116-140036-7e157edf
# 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 ] 20221116-140037-3ca17077
#> [ depends ] [email protected]:summary.csv -> incoming.csv
#> [ start ] 2022-11-16 14:00:37
#>
#> > 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 ] 2022-11-16 14:00:37
#> [ elapsed ] Ran report in 0.01383352 secs
#> [ artefact ] graph.png: a70cdfd037035a0b34e71b921fc9de42
#> [ ... ] info.rds: ed02cd1e1ea2c58142f4d9eb5046d0e5
#> [1] "20221116-140037-3ca17077"
# We can also directly pull previously run reports:
orderly::orderly_pull_archive("use_dependency", id, remote = remote,
root = path_local)
#> [ pull ] use_dependency:20221116-140036-c7fc695e
#> [ depends ] other/20221116-140036-7e157edf
#> [ pull ] other:20221116-140036-7e157edf already exists, skipping
#> [ import ] use_dependency:20221116-140036-c7fc695e
orderly::orderly_list_archive(root = path_local)
#> name id
#> 1 other 20221116-140036-7e157edf
#> 2 use_dependency 20221116-140036-c7fc695e