Provide helpers for base R home definitions

Author: jimhester

NAMESPACE

@@ -70,12 +70,14 @@ export(path_abs)
 export(path_common)
 export(path_dir)
 export(path_expand)
+export(path_expand_r)
 export(path_ext)
 export(path_ext_remove)
 export(path_ext_set)
 export(path_file)
 export(path_filter)
 export(path_home)
+export(path_home_r)
 export(path_join)
 export(path_norm)
 export(path_real)

NEWS.md

@@ -1,4 +1,4 @@
-# fs 1.1.0.9000
+# fs 1.2.0
 
 ## Breaking changes
 
@@ -8,7 +8,7 @@
   definitions from other programming environments such as python and rust. This
   is also more compatible with external tools such as git and ssh, both of
   which put user-level files in `USERPROFILE` by default. To mimic R's (and
-  previous) behavior use `Sys.setenv("R_FS_HOME" = Sys.getenv("R_USER"))`
+  previous) behavior there are functions `path_expand_r()` and `path_home_r()`.
 
 * Handling missing values are more consistent. In general `is_*` functions
   always return `FALSE` for missing values, `path_*` functions always propagate
@@ -22,7 +22,7 @@
 ## Bugfixes
 
 * Fix home expansion on systems without readline (#60).
-* Fix propagation of NA values in path_norm (#63).
+* Fix propagation of NA values in `path_norm()` (#63).
 
 ## Features
 

R/path.R

@@ -220,6 +220,8 @@ path_rel <- function(path, start = ".") {
 #' * `path_home()` constructs a path within the expanded users home directory,
 #'   calling it with _no_ arguments can be useful to verify what fs considers the
 #'   home directory.
+#' * `path_expand_r()` and `path_home_r()` are equivalents which always use R's
+#'   definition of the home directory.
 #' @details
 #' `path_expand()` Differs from [path.expand()] in the interpretation of the
 #' home directory of Windows. In particular `path_expand()` uses the path set
@@ -248,26 +250,41 @@ path_rel <- function(path, start = ".") {
 #' @inheritParams path_math
 #' @export
 #' @examples
-#' # Make fs home equivalent to R definition of home
-#' \dontrun{
-#' Sys.setenv("R_FS_HOME" = Sys.getenv("R_USER"))
-#' path_expand("~")
-#' }
+#' # You can use `path_home()` without arguments to see what is being used as
+#' the home diretory.
 #' path_home()
 #' path_home("R")
+#'
+#' # This will likely differ from the above on Windows
+#' path_home_r()
 path_expand <- function(path) {
   path <- enc2utf8(path)
 
   # We use the windows implementation if R_FS_HOME is set or if on windows
   path_tidy(expand_(path, Sys.getenv("R_FS_HOME") != "" || is_windows()))
 }
 
+#' @rdname path_expand
+#' @export
+path_expand_r <- function(path) {
+  path <- enc2utf8(path)
+
+  # Unconditionally use R_ExpandFileName
+  path_tidy(expand_(path, FALSE))
+}
+
 #' @rdname path_expand
 #' @export
 path_home <- function(...) {
   path(path_expand("~/"), ...)
 }
 
+#' @rdname path_expand
+#' @export
+path_home_r <- function(...) {
+  path(path_expand_r("~/"), ...)
+}
+
 #' Manipulate file paths
 #'
 #' `path_file()` returns the filename portion of the path, `path_dir()` returns

fs.Rproj

@@ -1,21 +1,21 @@
-Version: 1.0
-
-RestoreWorkspace: No
-SaveWorkspace: No
-AlwaysSaveHistory: Default
-
-EnableCodeIndexing: Yes
-UseSpacesForTab: Yes
-NumSpacesForTab: 2
-Encoding: UTF-8
-
-RnwWeave: knitr
-LaTeX: XeLaTeX
-
-AutoAppendNewline: Yes
-StripTrailingWhitespace: Yes
-
-BuildType: Package
-PackageUseDevtools: Yes
-PackageInstallArgs: --no-multiarch --with-keep.source
-PackageRoxygenize: rd,collate,namespace
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: knitr
+LaTeX: XeLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace