Add simple string interpolation for file from/to renaming #40
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merged
richfitz
force-pushed
the
mrc-4395
branch
2 times, most recently
from
c89f98a
to
02985c6
Compare
|
(pkgdown failure is unrelated to this PR, temporary failure with a certificate from the look of it) |
r-ash
approved these changes
Jul 21, 2023
There was a problem hiding this comment.
Looks good to me, would be nice if query and files had the same syntax for referring to the same thing. One using r from the environment as environment:r the other as ${r} which might be a bit confusing. But I understand why they are different and can't think of a better way to do that myself.
R/outpack_helpers.R
Outdated
| ##' @param envir An environment into which string interpolation may | ||
| ##' happen (see [orderly2::outpack_packet_use_dependency] for | ||
| ##' details on the string interpolation). The default here is to | ||
| ##' use the calling environment, whcih is typically reasonable, but |
There was a problem hiding this comment.
Suggested change
| ##' use the calling environment, whcih is typically reasonable, but | |
| ##' use the calling environment, which is typically reasonable, but |
R/outpack_packet.R
Outdated
Comment on lines
261
to
275
| ##' In all cases, if you want to import a directory of files from a | ||
| ##' packet, you must refer to the source with a trailing slash | ||
| ##' (e.g., `c(here = "there/")`), which will create the local | ||
| ##' directory `here/...` with files from the upstream packet | ||
| ##' directory `there/`. If you omit the slash then an error will be | ||
| ##' thrown suggesting that you add a slash if this is what you | ||
| ##' intended. | ||
| ##' | ||
| ##' You can use a limited form of string interpolation in the names of | ||
| ##' this argument (or its `to` column if using a `data.frame`); | ||
| ##' using `${variable}` will pick up values from `envir` and | ||
| ##' substitute them into your string. This is similar to the | ||
| ##' interpolation you might be familiar with from `glue::glue` or | ||
| ##' similar, but much simpler with no concatenation or other fancy | ||
| ##' features supported. |
There was a problem hiding this comment.
ah, except for the vestigial comment about data.frames - I'll remove that
|
I've highlighted the inconsistency in the docs a bit |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR probably requires a bit more checking than most of the ones in the current batch.
The idea here is to work well in a loop we need to do something like:
The first part of this (the
environment:rbit) is in #34, but the second part (the string interpolation on the third arg) is done here.An alternative would be something like:
which is (IMO) much uglier and error prone. I did wonder about adding data.frame support too, but removed it eventually to keep this PR simple (see 633c3e7).
I did think about a glue dependency for this bit of interpolation, but that implies we can do way too much, and so in the end I've gone for this bespoke solution. People can always use their own of course.
The docs would be easier to write if we rename
usetofilesinorderly_dependency