add drive methods

R/ms_drive.R

@@ -27,6 +27,12 @@
 #' - `get_item_properties(path, itemid)`: Get the properties (metadata) for a file or folder.
 #' - `set_item_properties(path, itemid, ...)`: Set the properties for a file or folder.
 #' - `list_shared_items(...), list_shared_files(...)`: List the drive items shared with you. See 'Shared items' below.
+#' - `load_dataframe(path, itemid, ...)`: Download a delimited file and return its contents as a data frame. See 'Saving and loading data' below.
+#' - `load_rds(path, itemid)`: Download a .rds file and return the saved object.
+#' - `load_rdata(path, itemid)`: Load a .RData or .Rda file into the specified environment.
+#' - `save_dataframe(df, file, ...)` Save a dataframe to a delimited file.
+#' - `save_rds(object, file)`: Save an R object to a .rds file.
+#' - `save_rdata(..., file)`: Save the specified objects to a .RData file.
 #'
 #' @section Initialization:
 #' Creating new objects of this class should be done via the `get_drive` methods of the [`ms_graph`], [`az_user`] or [`ms_site`] classes. Calling the `new()` method for this class only constructs the R object; it does not call the Microsoft Graph API to retrieve or create the actual drive.
@@ -61,6 +67,15 @@
 #'
 #' `create_folder` creates a folder with the specified path. Trying to create an already existing folder is an error.
 #'
+#' @section Saving and loading data:
+#' The following methods are provided to simplify the task of loading and saving datasets and R objects. They call down to the corresponding methods for the `ms_drive_item` class. The `load_*`` methods allow specifying the file to be loaded by either a path or item ID.
+#' - `load_dataframe` downloads a delimited file and returns its contents as a data frame. The delimiter can be specified with the `delim` argument; if omitted, this is "," if the file extension is .csv, ";" if the file extension is .csv2, and a tab otherwise. If the readr package is installed, the `readr::read_delim` function is used to parse the file, otherwise `utils::read.delim` is used. You can supply other arguments to the parsing function via the `...` argument.
+#' - `save_dataframe` is the inverse of `load_dataframe`: it uploads the given data frame to a folder item. Specify the delimiter with the `delim` argument. The `readr::write_delim` function is used to serialise the data if that package is installed, and `utils::write.table` otherwise.
+#' - `load_rds` downloads a .rds file and returns its contents as an R object. It is analogous to the base `readRDS` function but for OneDrive/SharePoint drive items.
+#' - `save_rds` uploads a given R object as a .rds file, analogously to `saveRDS`.
+#' - `load_rdata` downloads a .RData or .Rda file and loads its contents into the given environment. It is analogous to the base `load` function but for OneDrive/SharePoint drive items.
+#' - `save_rdata` uploads the given R objects as a .RData file, analogously to `save`.
+#'
 #' @section Shared items:
 #' The `list_shared_items` method shows the files and folders that have been shared with you. This is a named list of drive items, that you can use to access the shared files/folders. The arguments are:
 #' - `allow_external`: Whether to include items that were shared from outside tenants. The default is FALSE.
@@ -119,6 +134,15 @@
 #' obj2 <- drv$get_item(itemid=id)
 #' obj$properties$id == obj2$properties$id  # TRUE
 #'
+#' # saving and loading data
+#' drv$save_dataframe(iris, "path/to/iris.csv")
+#' iris2 <- drv$load_dataframe("path/to/iris.csv")
+#' identical(iris, iris2)  # TRUE
+#'
+#' drv$save_rds(iris, "path/to/iris.rds")
+#' iris3 <- drv$load_rds("path/to/iris.rds")
+#' identical(iris, iris3)  # TRUE
+#'
 #' # accessing shared files
 #' shared_df <- drv$list_shared_items()
 #' shared_df$remoteItem[[1]]$open()
@@ -230,6 +254,42 @@ public=list(
         out
     },
 
+    load_dataframe=function(path=NULL, itemid=NULL, ...)
+    {
+        self$get_item(path, itemid)$load_dataframe(...)
+    },
+
+    load_rdata=function(path=NULL, itemid=NULL, envir=parent.frame())
+    {
+        self$get_item(path, itemid)$load_rdata(envir=envir)
+    },
+
+    load_rds=function(path=NULL, itemid=NULL)
+    {
+        self$get_item(path, itemid)$load_rds()
+    },
+
+    save_dataframe=function(df, file, ...)
+    {
+        folder <- dirname(file)
+        if(folder == ".") folder <- "/"
+        self$get_item(folder)$save_dataframe(df, basename(file), ...)
+    },
+
+    save_rdata=function(..., file, envir=parent.frame())
+    {
+        folder <- dirname(file)
+        if(folder == ".") folder <- "/"
+        self$get_item(folder)$save_rdata(..., file=basename(file), envir=envir)
+    },
+
+    save_rds=function(object, file)
+    {
+        folder <- dirname(file)
+        if(folder == ".") folder <- "/"
+        self$get_item(folder)$save_rds(object, file=basename(file))
+    },
+
     print=function(...)
     {
         personal <- self$properties$driveType == "personal"

R/ms_drive_item.R

@@ -24,7 +24,7 @@
 #' - `get_parent_folder()`: Get the parent folder for this item, as a drive item object. Returns the root folder for the root. Not supported for remote items.
 #' - `get_path()`: Get the absolute path for this item, as a character string. Not supported for remote items.
 #' - `is_folder()`: Information function, returns TRUE if this item is a folder.
-#' - `load_dataframe(delim=NULL, ...)`: Download a delimited file and return its contents as a data frame. See 'Convenience methods' below.
+#' - `load_dataframe(delim=NULL, ...)`: Download a delimited file and return its contents as a data frame. See 'Saving and loading data' below.
 #' - `load_rds()`: Download a .rds file and return the saved object.
 #' - `load_rdata(envir)`: Load a .RData or .Rda file into the specified environment.
 #' - `save_dataframe(df, file, delim=",", ...)` Save a dataframe to a delimited file.
@@ -73,7 +73,7 @@
 #'
 #' This method returns a URL to access the item, for `type="view"` or "`type=edit"`. For `type="embed"`, it returns a list with components `webUrl` containing the URL, and `webHtml` containing a HTML fragment to embed the link in an IFRAME. The default is a viewable link, expiring in 7 days.
 #'
-#' @section Convenience methods:
+#' @section Saving and loading data:
 #' The following methods are provided to simplify the task of loading and saving datasets and R objects.
 #' - `load_dataframe` downloads a delimited file and returns its contents as a data frame. The delimiter can be specified with the `delim` argument; if omitted, this is "," if the file extension is .csv, ";" if the file extension is .csv2, and a tab otherwise. If the readr package is installed, the `readr::read_delim` function is used to parse the file, otherwise `utils::read.delim` is used. You can supply other arguments to the parsing function via the `...` argument.
 #' - `save_dataframe` is the inverse of `load_dataframe`: it uploads the given data frame to a folder item. Specify the delimiter with the `delim` argument. The `readr::write_delim` function is used to serialise the data if that package is installed, and `utils::write.table` otherwise.
@@ -123,6 +123,16 @@
 #' # delete the file (will ask for confirmation first)
 #' myfile$delete()
 #'
+#' # saving and loading data
+#' myfolder <- mydrv$get_item("myfolder")
+#' myfolder$save_dataframe(iris, "iris.csv")
+#' iris2 <- myfolder$get_item("iris.csv")$load_dataframe()
+#' identical(iris, iris2)  # TRUE
+#'
+#' myfolder$save_rds(iris, "iris.rds")
+#' iris3 <- myfolder$get_item("iris.rds")$load_rds()
+#' identical(iris, iris3)  # TRUE
+#'
 #' }
 #' @format An R6 object of class `ms_drive_item`, inheriting from `ms_object`.
 #' @export