Skip to content

Commit

Permalink
Update vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
@elipousson
elipousson committed Oct 21, 2024
1 parent fd1cebe commit 8ff3dab
Show file tree
Hide file tree
Showing 3 changed files with 168 additions and 173 deletions.
52 changes: 52 additions & 0 deletions vignettes/articles/file-management.Rmd
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "Managing files and folders"
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
comment = "#>"
)
```

```{r setup}
library(sharepointr)
library(tidyverse)
```

## Common uses

Deleting empty directories:

```{r}
url <- "https://bmore.sharepoint.com/:f:/r/sites/DOP-ALL/Shared%20Documents/LUUD?csf=1&web=1&e=g00uHf"
luud_items <- sp_dir_info(url, recurse = TRUE)
```

Workspaces

- 40' setback from ROW for E-2 districts


```{r}
luud_items |>
dplyr::mutate(
filename = if_else(
type == "file",
fs::path_file(name),
NA_character_
),
fileext = fs::path_ext(name),
dir_path = if_else(
type == "file",
fs::path_dir(name),
NA_character_
),
dir_name = basename(dir_path)
) |>
View()
openxlsx2::write_xlsx("LUUD-Items.xlsx")
```

97 changes: 37 additions & 60 deletions vignettes/articles/read-write.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ download_sp_item(
)
#> Loading Microsoft Graph login for default tenant
#> ℹ Downloading SharePoint item to
#> '/var/folders/3f/50m42dx1…
#> '/var/folders/3f/50m42dx1333_dfqb5772j6_40000gn…
#> Error: Path exists and overwrite is FALSE
#> ✖ Downloading SharePoint item to '/var/folders/3f/50m42dx1…
#> ✖ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000gn…
```

For files on SharePoint, `read_sharepoint()` extends `download_sp_item()` by downloading the selected item to a temporary folder by default and, depending on the file extension, tries to read the file using `{readr}`, `{readxl}`, `{officer}`, or `{sf}`.
Expand All @@ -36,58 +36,41 @@ For files on SharePoint, `read_sharepoint()` extends `download_sp_item()` by dow
``` r
docx <- read_sharepoint(docx_url)
#> Loading Microsoft Graph login for default tenant
#> ℹ Downloading SharePoint item to '/var/folders/3f/50m42dx1…✔ Downloading SharePoint item to '/var/folders/3f/50m42dx1…
#> ℹ Reading item with `officer::read_docx()`✔ Reading item with `officer::read_docx()` [44ms]
```

``` r
#> ℹ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000gn…✔ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000gn…
#> ℹ Reading item with `officer::read_docx()`✔ Reading item with `officer::read_docx()` [53ms]

docx
#> rdocx document with 62 element(s)
#>
#> * styles:
#> Normal heading 1
#> "paragraph" "paragraph"
#> heading 2 Default Paragraph Font
#> "paragraph" "character"
#> Normal Table No List
#> "table" "numbering"
#> Heading 1 Char Table Grid
#> "character" "table"
#> List Paragraph Heading 2 Char
#> "paragraph" "character"
#> Title Title Char
#> "paragraph" "character"
#> Normal (Web) header
#> "paragraph" "paragraph"
#> Header Char footer
#> "character" "paragraph"
#> Footer Char markedcontent
#> "character" "character"
#> TOC Heading toc 1
#> "paragraph" "paragraph"
#> toc 2 Hyperlink
#> "paragraph" "character"
#> toc 3 toc 4
#> "paragraph" "paragraph"
#> toc 5 toc 6
#> "paragraph" "paragraph"
#> toc 7 toc 8
#> "paragraph" "paragraph"
#> toc 9 Unresolved Mention
#> "paragraph" "character"
#> FollowedHyperlink Revision
#> "character" "paragraph"
#> Unresolved Mention1 annotation reference
#> "character" "character"
#> annotation text Comment Text Char
#> "paragraph" "character"
#> annotation subject Comment Subject Char
#> "paragraph" "character"
#> Balloon Text Balloon Text Char
#> "paragraph" "character"
#> footnote text Footnote Text Char
#> "paragraph" "character"
#> Normal heading 1 heading 2
#> "paragraph" "paragraph" "paragraph"
#> Default Paragraph Font Normal Table No List
#> "character" "table" "numbering"
#> Heading 1 Char Table Grid List Paragraph
#> "character" "table" "paragraph"
#> Heading 2 Char Title Title Char
#> "character" "paragraph" "character"
#> Normal (Web) header Header Char
#> "paragraph" "paragraph" "character"
#> footer Footer Char markedcontent
#> "paragraph" "character" "character"
#> TOC Heading toc 1 toc 2
#> "paragraph" "paragraph" "paragraph"
#> Hyperlink toc 3 toc 4
#> "character" "paragraph" "paragraph"
#> toc 5 toc 6 toc 7
#> "paragraph" "paragraph" "paragraph"
#> toc 8 toc 9 Unresolved Mention
#> "paragraph" "paragraph" "character"
#> FollowedHyperlink Revision Unresolved Mention1
#> "character" "paragraph" "character"
#> annotation reference annotation text Comment Text Char
#> "character" "paragraph" "character"
#> annotation subject Comment Subject Char Balloon Text
#> "paragraph" "character" "paragraph"
#> Balloon Text Char footnote text Footnote Text Char
#> "character" "paragraph" "character"
#> footnote reference
#> "character"
#>
Expand All @@ -109,7 +92,7 @@ upload_sp_item(
dest = folder_url
)
#> Loading Microsoft Graph login for default tenant
#> ℹ Uploading file 'nc.gpkg' to SharePoint drive✔ File upload complete [1.9s]
#> ℹ Uploading file 'nc.gpkg' to SharePoint drive✔ File upload complete [1.2s]
```

Using `read_sharepoint()`, we can confirm that the file has been uploaded:
Expand All @@ -118,21 +101,15 @@ Using `read_sharepoint()`, we can confirm that the file has been uploaded:
``` r
sp_drive <- get_sp_drive(folder_url)
#> Loading Microsoft Graph login for default tenant
```

``` r

nc <- read_sharepoint(
"RStats/nc.gpkg",
drive = sp_drive
)
#> ℹ Downloading SharePoint item to
#> '/var/folders/3f/50m42dx1…
#> ✔ Downloading SharePoint item to '/var/folders/3f/50m42dx1…
#> ℹ Reading item with `sf::read_sf()`✔ Reading item with `sf::read_sf()` [27ms]
```

``` r
#> '/var/folders/3f/50m42dx1333_dfqb5772j6_40000gn…
#> ✔ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000gn…
#> ℹ Reading item with `sf::read_sf()`✔ Reading item with `sf::read_sf()` [28ms]

plot(nc["AREA"])
```
Expand All @@ -149,7 +126,7 @@ write_sharepoint(
dest = folder_url
)
#> Loading Microsoft Graph login for default tenant
#> ℹ Uploading file 'mtcars.csv' to SharePoint drive✔ File upload complete [970ms]
#> ℹ Uploading file 'mtcars.csv' to SharePoint drive✔ File upload complete [1.6s]
```

To wrap up this example, we need to remove the uploaded files from SharePoint to keep a tidy shared file system.
Expand Down
Loading

0 comments on commit 8ff3dab

Please sign in to comment.