sshfs: Mounts and unmounts a remote folder

In eliocamp/mountr: Mount remote folders with 'sshfs' from R

Mounts and unmounts a remote folder

Description

Mounts and unmounts a remote folder

Usage

sshfs_mount(
  user,
  remote_server,
  remote_folder,
  local_folder,
  permission = c("r", "rw"),
  extra_args = ""
)

sshfs_unmount(mount_point)

Arguments

user	user
remote_server	remote server or tunnel object returned by [tunnel_open]
remote_folder	server's folder to be mounted
local_folder	local folder where to mount
permission	either "r" or "rw"
extra_args	character string of extra arguments passed to 'sshfs'.
mount_point	mount_point object returned from [sshfs_mount]

Examples

## Not run: 
mount <- sshfs_mount(user = "myself",
                     remote_server = "server.domain",
                     remote_folder = "~/data_folder",    # expands to "/home/myself/data_folder"
                     local_folder = "DATA")
# Mount the mountpoint
mount$mount()
# Now you can access your files with
list.files(mount$folder)

# Unmount when done
sshfs_unmount(mount)
# or mount$unmount()

# If you need to tunnel over another server, first create the
# tunnel and then pass the object as a `remote_server`
tunnel <- tunnel_open(user = "myself",
                      tunnel_server = "portal.domain",
                      remote_server = "server.domain")

mount <- sshfs_mount(user = "myself",
                     remote_server = tunnel,
                     remote_folder = "~/data_folder",
                     local_folder = "DATA")
mount$mount()
# When done, unmount and close the tunnel.
sshfs_unmount(mount)
tunnel_close(tunnel)


## End(Not run)

eliocamp/mountr documentation built on May 25, 2023, 7:35 p.m.