diff --git a/pkgdown.yml b/pkgdown.yml index a78a691..f2798c1 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: sp_url: sp_url.html -last_built: 2024-05-29T20:31Z +last_built: 2024-06-13T02:18Z urls: reference: https://elipousson.github.io/sharepointr/reference article: https://elipousson.github.io/sharepointr/articles diff --git a/reference/index.html b/reference/index.html index fb75a3b..800b55a 100644 --- a/reference/index.html +++ b/reference/index.html @@ -94,6 +94,16 @@

All functionslist_sp_item_versions() + +
List versions for a SharePoint item
+
+ + list_sp_pages() get_sp_page() +
+
List SharePoint pages or get a single SharePoint page
+
+ read_sharepoint()
Read a SharePoint item based on a file URL or file name and site details
diff --git a/reference/is_sp_url.html b/reference/is_sp_url.html index 2a24179..57b4bbb 100644 --- a/reference/is_sp_url.html +++ b/reference/is_sp_url.html @@ -58,6 +58,8 @@

Usage is_sp_site_url(x) +is_sp_site_page_url(x) + is_sp_doc_url(x) is_sp_type_url(x, type = "w") diff --git a/reference/list_sp_item_versions.html b/reference/list_sp_item_versions.html new file mode 100644 index 0000000..d40fdaa --- /dev/null +++ b/reference/list_sp_item_versions.html @@ -0,0 +1,147 @@ + +List versions for a SharePoint item — list_sp_item_versions • sharepointr + Skip to contents + + +
+
+
+

List versions for a SharePoint item

+ Source: R/sp_item_versions.R +
list_sp_item_versions.Rd
+
+ +
+

This is an implementation of a new method for a ms_item object using the +do_operation method directly. The intent is to add a list_versions method +back to the Microsoft365R package which may include changes to the +functionality and output of this function.

+
+ +
+

Usage

+ 
list_sp_item_versions(..., sp_item = NULL, as_data_frame = TRUE)
+
+ +
+

Arguments

+
...
+

Arguments passed on to get_sp_item

path
+

A SharePoint file URL or the relative path to a file located in a +SharePoint drive. If input is a relative path, the string should not +include the drive name. If input is a shared file URL, the text "Shared " +is removed from the start of the SharePoint drive name by default. If file +is a document URL, the default_drive_name argument is used as the +drive_name and the item_id is extracted from the URL.

+ +
item_id
+

A SharePoint item ID passed to the itemid parameter of the +get_item method for ms_drive objects.

+ +
drive_name,drive_id
+

SharePoint drive name or ID.

+ +
drive
+

A ms_drive object. If drive is supplied, drive_name, +site_url, and any additional parameters passed to ... are ignored.

+ +
properties
+

If TRUE, use the get_item_properties method and return +item properties instead of the item.

+ +
site_url
+

A SharePoint site URL in the format "https://[tenant +name].sharepoint.com/sites/[site name]". Any SharePoint item or document +URL can also be parsed to build a site URL using the tenant and site name +included in the URL.

+ +
call
+

The execution environment of a currently +running function, e.g. caller_env(). The function will be +mentioned in error messages as the source of the error. See the +call argument of abort() for more information.

+ + +
+ + +
sp_item
+

SharePoint item to get versions for. Additional parameters +passed to ... are ignored if sp_item is supplied.

+ + +
as_data_frame
+

If TRUE, return a data frame of versions. If FALSE, +return a list.

+ +
+
+

Value

+ + +

A data frame if as_data_frame = TRUE or a list if FALSE.

+
+ +
+ + +
+

Developed by Eli Pousson.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/reference/list_sp_pages.html b/reference/list_sp_pages.html new file mode 100644 index 0000000..5f8ce4b --- /dev/null +++ b/reference/list_sp_pages.html @@ -0,0 +1,131 @@ + +List SharePoint pages or get a single SharePoint page — list_sp_pages • sharepointr + Skip to contents + + +
+
+
+

List SharePoint pages or get a single SharePoint page

+ Source: R/sp_pages.R +
list_sp_pages.Rd
+
+ +
+

List SharePoint pages or get a single SharePoint page

+
+ +
+

Usage

+ 
list_sp_pages(
+  ...,
+  site = NULL,
+  page_type = c("sitePage", "page"),
+  as_data_frame = TRUE
+)
+
+get_sp_page(page_url = NULL, page_id = NULL, ..., site = NULL)
+
+ +
+

Arguments

+
...
+

Arguments passed on to get_sp_site

site_url
+

A SharePoint site URL in the format "https://[tenant +name].sharepoint.com/sites/[site name]". Any SharePoint item or document +URL can also be parsed to build a site URL using the tenant and site name +included in the URL.

+ +
site_name,site_id
+

Site name or ID of the SharePoint site as an +alternative to the SharePoint site URL. Exactly one of site_url, +site_name, and site_id must be supplied.

+ +
refresh
+

If TRUE, get a new site even if the existing site is cached +as a local option. If FALSE, use the cached ms_site object.

+ +
cache
+

If TRUE, cache site to a file using cache_sp_site().

+ +
cache_file
+

File name for cached file if cache = TRUE. Defaults to +"sp_site.rds" or option set with sharepointr.cache_file_site.

+ +
call
+

The execution environment of a currently +running function, e.g. caller_env(). The function will be +mentioned in error messages as the source of the error. See the +call argument of abort() for more information.

+ +
overwrite
+

If TRUE, replace the existing cached object named by +cache_file with the new object. If FALSE, error if a cached file with +the same cache_file name already exists.

+ + +
+ + +
page_type
+

c("sitePage", "page")

+ +
+ +
+ + +
+

Developed by Eli Pousson.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/reference/sp_url_parse.html b/reference/sp_url_parse.html index ebb8f8a..a2c3ebe 100644 --- a/reference/sp_url_parse.html +++ b/reference/sp_url_parse.html @@ -1,15 +1,13 @@ Parse a SharePoint URL using httr2::url_parse — sp_url_parse • sharepointrParse a SharePoint URL using httr2::url_parse — sp_url_parse • sharepointr @@ -61,10 +59,9 @@

sp_url_parse() parses a URL into a named list of parts.

sp_url_parse_hostname() parses the hostname into a tenant and base_url.

-

sp_url_parse_hostname() parses the hostname into a path into a url_type, -permissions, site_name, file_path, and file.

-

sp_url_parse_hostname() parses the query to turn the sourcedoc value into -an item_id and return other query values as a named list.

+

sp_url_parse_path() parses the path into a URL type, permissions, drive +name, file path, and file name.

+

sp_url_parse_query() parses the item ID from a query.

diff --git a/search.json b/search.json index f463bf1..3b56bf9 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://elipousson.github.io/sharepointr/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 sharepointr authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://elipousson.github.io/sharepointr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Eli Pousson. Author, maintainer, copyright holder.","code":""},{"path":"https://elipousson.github.io/sharepointr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Pousson E (2024). sharepointr: Read Write SharePoint Sites. R package version 0.1.0, https://elipousson.github.io/sharepointr/, https://github.com/elipousson/sharepointr.","code":"@Manual{, title = {sharepointr: Read and Write from SharePoint Sites}, author = {Eli Pousson}, year = {2024}, note = {R package version 0.1.0, https://elipousson.github.io/sharepointr/}, url = {https://github.com/elipousson/sharepointr}, }"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"sharepointr","dir":"","previous_headings":"","what":"Read and Write from SharePoint Sites","title":"Read and Write from SharePoint Sites","text":"goal SharePointR make easier read, write, work files stored SharePoint extending Microsoft365R package.","code":""},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Read and Write from SharePoint Sites","text":"can install development version SharePointR like :","code":"# pak::pkg_install(\"elipousson/sharepointr\")"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"requirements","dir":"","previous_headings":"","what":"Requirements","title":"Read and Write from SharePoint Sites","text":"use package ({Microsoft365}) must: work school account access Microsoft SharePoint enabled permissions default {Microsoft365} app ID See {Microsoft365} documentation app registration information.","code":""},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Read and Write from SharePoint Sites","text":"{Microsoft365} uses S6 methods nearly everything may difficult users (included) less familiar interface. sharepointr package seeks ease challenge wrapping {Microsoft365} methods adding support specification SharePoint sites, drives, items using SharePoint URLs instead item drive ID values.","code":"library(sharepointr)"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"reading-and-writing-objects-to-and-from-sharepoint","dir":"","previous_headings":"Usage","what":"Reading and writing objects to and from SharePoint","title":"Read and Write from SharePoint Sites","text":"useful functions users may read_sharepoint() write_sharepoint(). read_sharepoint() downloads SharePoint file temporary folder , based file extension, reads environment using appropriate function package (e.g. using officer::read_docx() Microsoft Word files sf::read_sf() common spatial data files): write_sharepoint() saves R object local files uses upload_sp_item() uploads file SharePoint. plan adding features allow custom mapping file extensions object classes specific functions packages adding thorough documentation. Feel free submit issue make pull request ideas .","code":"docx_shared_url <- \"https://bmore.sharepoint.com/:w:/r/sites/MayorsOffice-DataGovernance/Shared%20Documents/General/Baltimore%20Data%20Academy/Baltimore%20Data%20Academy%20Announcement%20Content.docx?d=w0a50d3cd74ce4a8da6d82596037f0148&csf=1&web=1&e=cBURo2\" read_sharepoint(docx_shared_url) #> Loading Microsoft Graph login for default tenant #> ℹ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000g… #> ✔ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000g… #> #> ℹ Reading item with `officer::read_docx()` #> ✔ Reading item with `officer::read_docx()` [41ms] #> #> rdocx document with 19 element(s) #> #> * styles: #> Normal Default Paragraph Font Normal Table #> \"paragraph\" \"character\" \"table\" #> No List List Paragraph annotation reference #> \"numbering\" \"paragraph\" \"character\" #> annotation text Comment Text Char annotation subject #> \"paragraph\" \"character\" \"paragraph\" #> Comment Subject Char Hyperlink Unresolved Mention #> \"character\" \"character\" \"character\" #> #> * Content at cursor location: #> level num_id #> 1 NA NA #> text #> 1 If you have questions or feedback about the program, contact Chief Data Officer Justin Elszasz at justin.elszasz@baltimorecity.gov. Happy learning! #> style_name content_type #> 1 NA paragraph"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"working-with-sharepoint-items-lists-and-plans","dir":"","previous_headings":"Usage","what":"Working with SharePoint items, lists, and plans","title":"Read and Write from SharePoint Sites","text":"package currently support three main categories SharePoint objects: Items (including directories files) item properties Lists list items Plans tasks Typically functions return ms_object object, list ms_object objects, data frame. cases, data frame based object properties includes list column ms_object stored. example, get_sp_item() returns ms_drive_item object supports parsing shared file folder URLs: Set as_data_frame = TRUE return data frame instead ms_drive_item object: basic functions “get” objects extended functions like download_sp_item() adds support downloading copies SharePoint files (function powers read_sharepoint()): original Microsoft365R S6 object methods already return data frame default sp_dir_info(): Others use as_data_frame parameter convert list data frame convenient alternative.","code":"get_sp_item(docx_shared_url) #> Loading Microsoft Graph login for default tenant #> #> directory id: 017P4HV6ON2NIAVTTURVFKNWBFSYBX6AKI #> web link: https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/_layouts/15/Doc.aspx?sourcedoc=%7B0A50D3CD-74CE-4A8D-A6D8-2596037F0148%7D&file=Baltimore%20Data%20Academy%20Announcement%20Content.docx&action=default&mobileredirect=true #> type: file #> --- #> Methods: #> copy, create_folder, create_share_link, delete, #> do_operation, download, get_item, get_list_pager, #> get_parent_folder, get_path, is_folder, list_files, #> list_items, load_dataframe, load_rdata, load_rds, move, #> open, save_dataframe, save_rdata, save_rds, sync_fields, #> update, upload get_sp_item(docx_shared_url, as_data_frame = TRUE) #> Loading Microsoft Graph login for default tenant #> @odata.context #> 1 https://graph.microsoft.com/beta/$metadata#drives('b%21txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO')/root/$entity #> @microsoft.graph.downloadUrl #> 1 https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/_layouts/15/download.aspx?UniqueId=0a50d3cd-74ce-4a8d-a6d8-2596037f0148&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvYm1vcmUuc2hhcmVwb2ludC5jb21AMzEyY2IxMjYtYzZhZS00ZmMyLTgwMGQtMzE4ZTY3OWNlNmM3IiwiaXNzIjoiMDAwMDAwMDMtMDAwMC0wZmYxLWNlMDAtMDAwMDAwMDAwMDAwIiwibmJmIjoiMTcwNjc1NDU1NyIsImV4cCI6IjE3MDY3NTgxNTciLCJlbmRwb2ludHVybCI6ImVWS1o5aHllbHVsNU9PdzR6OWQ1U01sOVBkZXpXTjNOU3NscWxGM3V2ME09IiwiZW5kcG9pbnR1cmxMZW5ndGgiOiIxNTAiLCJpc2xvb3BiYWNrIjoiVHJ1ZSIsImNpZCI6ImlUQVg3bGRUOWtDZy83UE5venJGV2c9PSIsInZlciI6Imhhc2hlZHByb29mdG9rZW4iLCJzaXRlaWQiOiJNV1JoTURGallqY3ROelpqTnkwME5EZzNMV0l6T1RndFpXTTJNR1JtWmpobU5USmsiLCJhcHBfZGlzcGxheW5hbWUiOiJBenVyZVIvTWljcm9zb2Z0MzY1UiIsImdpdmVuX25hbWUiOiJFbGkiLCJmYW1pbHlfbmFtZSI6IlBvdXNzb24iLCJhcHBpZCI6ImQ0NGEwNWQ1LWM2YTUtNGJiYi04MmQyLTQ0MzEyMzcyMjM4MCIsInRpZCI6IjMxMmNiMTI2LWM2YWUtNGZjMi04MDBkLTMxOGU2NzljZTZjNyIsInVwbiI6ImVsaS5wb3Vzc29uQGJhbHRpbW9yZWNpdHkuZ292IiwicHVpZCI6IjEwMDMyMDAxRkQ3Q0UxMjQiLCJjYWNoZWtleSI6IjBoLmZ8bWVtYmVyc2hpcHwxMDAzMjAwMWZkN2NlMTI0QGxpdmUuY29tIiwic2NwIjoiZ3JvdXAud3JpdGUgYWxsc2l0ZXMubWFuYWdlIGFsbHNpdGVzLndyaXRlIiwidHQiOiIyIiwiaXBhZGRyIjoiMjAuMTkwLjE1MS4zNyJ9.EP15oZ01FLz_6tPq0kgN3JLliBIPtAg3aYhscvPfpic&ApiVersion=2.0 #> createdDateTime eTag #> 1 2023-01-13T16:42:07Z \"{0A50D3CD-74CE-4A8D-A6D8-2596037F0148},57\" #> id lastModifiedDateTime #> 1 017P4HV6ON2NIAVTTURVFKNWBFSYBX6AKI 2023-01-26T18:17:57Z #> name #> 1 Baltimore Data Academy Announcement Content.docx #> webUrl #> 1 https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/_layouts/15/Doc.aspx?sourcedoc=%7B0A50D3CD-74CE-4A8D-A6D8-2596037F0148%7D&file=Baltimore%20Data%20Academy%20Announcement%20Content.docx&action=default&mobileredirect=true #> cTag size #> 1 \"c:{0A50D3CD-74CE-4A8D-A6D8-2596037F0148},141\" 79504 #> createdBy #> 1 Justin.Elszasz@baltimorecity.gov, a43c19f9-9a13-403d-9234-0c13f4e84b1c, Elszasz, Justin #> lastModifiedBy #> 1 Michael.Gottlieb@baltimorecity.gov, a2dedf36-3fce-4998-92f5-9350e749769f, Gottlieb, Michael (BCIT) #> shared #> 1 users #> parentReference #> 1 documentLibrary, b!txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO, 017P4HV6NGOMGBBVI5GBBZU5BFDTPDKJ7W, Baltimore Data Academy, /drives/b!txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO/root:/General/Baltimore Data Academy, 1da01cb7-76c7-4487-b398-ec60dff8f52d #> file #> 1 application/vnd.openxmlformats-officedocument.wordprocessingml.document, HXogYD+5fQrvr/nsAemsu10d62M= #> fileSystemInfo ms_item #> 1 2023-01-13T16:42:07Z, 2023-01-26T18:17:57Z withr::with_tempdir({ docx_dest <- download_sp_item(docx_shared_url) file.exists(docx_dest) }) #> Loading Microsoft Graph login for default tenant #> ℹ Downloading SharePoint item to 'Baltimore Data Academy Announcement Content.d… #> ✔ Downloading SharePoint item to 'Baltimore Data Academy Announcement Content.d… #> #> [1] TRUE sp_dir_info(\"https://bmore.sharepoint.com/:w:/r/sites/MayorsOffice-DataGovernance/Shared%20Documents/General/Baltimore%20Data%20Academy\") #> Loading Microsoft Graph login for default tenant #> name #> 1 General/Baltimore Data Academy/Logos #> 2 General/Baltimore Data Academy/BALT 02 Interpreting Data - Student Coursebook.pdf #> 3 General/Baltimore Data Academy/BALT 03_Leading with Data_Workday Lesson 1_03292023.pdf #> 4 General/Baltimore Data Academy/BALT 04_Data Stewardship_Workday Lesson 1_03292023.pdf #> 5 General/Baltimore Data Academy/BALT 05_Measuring Government Performance_Course Access Instructions_Workday Lesson 1_02282023.pdf #> 6 General/Baltimore Data Academy/Baltimore Data Academy Announcement Content.docx #> 7 General/Baltimore Data Academy/Baltimore Data Academy New Course Announcement 7.11.23.docx #> 8 General/Baltimore Data Academy/Curriculum One Pager.pdf #> 9 General/Baltimore Data Academy/Document.docx #> 10 General/Baltimore Data Academy/Foundations of Data Literacy_2023 [43].pdf #> 11 General/Baltimore Data Academy/Interpreting Data with Greater Accuracy and Insight[97].pdf #> 12 General/Baltimore Data Academy/Last SR by Agency as of 7.11.23.xlsx #> size isdir id type #> 1 3.26M TRUE 017P4HV6I3IGKTFCO2FZD3FXPCGUPJSO6G directory #> 2 703.38K FALSE 017P4HV6KITC7MJJJESFD35BIDU5DR4BSL file #> 3 388.91K FALSE 017P4HV6N2LBZHX6ERCBCIQRJIXGTZMYCK file #> 4 389.67K FALSE 017P4HV6ICFKFITU4WC5CYAFJUTZAMHP7K file #> 5 391.34K FALSE 017P4HV6MQCBPQQD6VUVCJWMWAKTIBZNYQ file #> 6 77.64K FALSE 017P4HV6ON2NIAVTTURVFKNWBFSYBX6AKI file #> 7 53.98K FALSE 017P4HV6PKOSFTLSMOAJDK3OGKFUVCIICU file #> 8 88.45K FALSE 017P4HV6OKNLH7UWTQJBEZXWNFXBGBC6OC file #> 9 48.51K FALSE 017P4HV6L5XTQ7IOMVYBGKSYMSOYDXMMPZ file #> 10 536.85K FALSE 017P4HV6KALORFIRC2IBB3RN52WE4V7QGU file #> 11 618.2K FALSE 017P4HV6NWPAN6PTWC3FEJB3KRR2WDWXFM file #> 12 18.51K FALSE 017P4HV6K2WP2LBTN6PFGLVY4PIWOY7IAR file"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"helpers-for-sharepoint-sites-and-drives","dir":"","previous_headings":"Usage","what":"Helpers for SharePoint sites and drives","title":"Read and Write from SharePoint Sites","text":"functions package rely pair helper functions: get_sp_site(), get_sp_drive(), get_sp_item(), can parse URL determine SharePoint site URL, drive name, file path based URL. get_sp_site() minimal wrapper Microsoft365R::get_sharepoint_site(): get_sp_drive() returns ms_drive object required SharePoint URL includes name drive (otherwise returns drive named “sharepointr.default_drive_name” option):","code":"site_url <- \"https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance\" get_sp_site(site_url = site_url) #> Loading Microsoft Graph login for default tenant #> #> directory id: bmore.sharepoint.com,1da01cb7-76c7-4487-b398-ec60dff8f52d,7abe409a-2aeb-4eb8-8dc3-8fe9106907af #> web link: https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance #> description: If you work with or are interested in data, feel free to join! #> --- #> Methods: #> delete, do_operation, get_drive, get_group, get_list, #> get_list_pager, get_lists, list_drives, list_subsites, #> sync_fields, update get_sp_drive(docx_shared_url) #> Loading Microsoft Graph login for default tenant #> #> directory id: b!txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO #> web link: https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/Shared%20Documents #> description: #> --- #> Methods: #> copy_item, create_folder, create_share_link, delete, #> delete_item, do_operation, download_file, download_folder, #> get_item, get_item_properties, get_list_pager, list_files, #> list_items, list_shared_files, list_shared_items, #> load_dataframe, load_rdata, load_rds, move_item, open_item, #> save_dataframe, save_rdata, save_rds, set_item_properties, #> sync_fields, update, upload_file, upload_folder"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"related-packages","dir":"","previous_headings":"","what":"Related packages","title":"Read and Write from SharePoint Sites","text":"similar packages available: sharrpoint: R package interact Sharepoint API (files & lists). sharepointr: R package reading writing SharePoint lists. msgraphr: minimal R wrapper SharePoint Online (Office 365) APIs (last updated 3 years ago). know package name conflicts existing sharepointr package. Unfortunately, didn’t notice find set repository. However, given appears sharepointr package may longer development, plan stick current name time .","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/AzureR_config.html","id":null,"dir":"Reference","previous_headings":"","what":"List or delete files from the AzureR configuration directory — AzureR_config","title":"List or delete files from the AzureR configuration directory — AzureR_config","text":"AzureR_config_ls() uses rappdirs::user_config_dir() fs::dir_ls() list files AzureR configuration directory. AzureR_config_delete() uses fs::file_delete() remove \"graph_logins.json\" configuration file needed. Use function caution may option address \"Unable refresh token\" error.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/AzureR_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List or delete files from the AzureR configuration directory — AzureR_config","text":"","code":"AzureR_config_ls(path = NULL, glob = \"*.json\") AzureR_config_delete(path = NULL, filename = \"graph_logins.json\")"},{"path":"https://elipousson.github.io/sharepointr/reference/AzureR_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List or delete files from the AzureR configuration directory — AzureR_config","text":"path Path configuration directory AzureR package JSON file graph_logins stored. NULL, path set rappdirs::user_config_dir(\"AzureR\"). glob wildcard aka globbing pattern (e.g. *.csv) passed grep() filter paths. filename Filename delete configuration directory. Defaults \"graph_logins.json\". Set NULL path contains file name.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/cache_ms_obj.html","id":null,"dir":"Reference","previous_headings":"","what":"Cache a ms_object class object to a file — cache_ms_obj","title":"Cache a ms_object class object to a file — cache_ms_obj","text":"Cache ms_object class object file","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/cache_ms_obj.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cache a ms_object class object to a file — cache_ms_obj","text":"","code":"cache_ms_obj( x, cache_file, cache_dir = NULL, what = \"ms_site\", overwrite = FALSE, arg = caller_arg(x), call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/cache_ms_obj.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cache a ms_object class object to a file — cache_ms_obj","text":"cache_file File name cached file. Required. cache_dir Cache directory. default, uses environmental variable named \"sharepointr.cache_dir\". \"sharepointr.cache_dir\" set, cache directory set rappdirs::user_cache_dir(\"sharepointr\"). overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete SharePoint items (files and directories) — delete_sp_item","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"delete_sp_item() deletes items including files directories using delete method . default confirm = TRUE, requires user respond prompt: \"really want delete drive item ...? (yes//cancel)\" continue.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"","code":"delete_sp_item( path = NULL, confirm = TRUE, by_item = FALSE, ..., item_id = NULL, item_url = NULL, item = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"path SharePoint file URL relative path file located SharePoint drive. input relative path, string include drive name. input shared file URL, text \"Shared \" removed start SharePoint drive name default. file document URL, default_drive_name argument used drive_name item_id extracted URL. confirm TRUE, confirm deleting item. TRUE session interactive, function error. by_item business OneDrive SharePoint document libraries, may need set by_item = TRUE delete contents folder depending policies set SharePoint administrator policies. Note, method can slow large folders. ... Arguments passed get_sp_item drive_name,drive_id SharePoint drive name ID. as_data_frame TRUE, return data frame. FALSE (default), return ms_item ms_item_properties object. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. item ms_drive_item class object. Optional path parameters get SharePoint item supplied. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"Trouble-shooting errors get error: \"resource attempting access locked\", another user may file file within directory open editing. Close file try deleting item . get error: \"Request cancelled event received. attempting delete non-empty folder, possible hold.\" set by_item = TRUE try .","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Download one or more items from SharePoint to a file or folder — download_sp_item","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"download_sp_item() wraps download method SharePoint items making easier download items based shared file URL document URL.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"","code":"download_sp_item( path = NULL, new_path = \"\", ..., item_id = NULL, item_url = NULL, item = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, dest = NULL, overwrite = FALSE, recursive = FALSE, parallel = FALSE, call = caller_env() ) download_sp_file(file, new_path = \"\", ..., call = caller_env())"},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"path, file Required. SharePoint shared file URL, document URL, , item_id supplied, file name use path set dest location filename downloaded item. new_path Path directory downloaded item. Optional dest supplied. path contains file name, item downloaded using file name instead file name original item. new_path refers nonexistent directory item file, directory silently created using fs::dir_create(). ... Arguments passed get_sp_item drive_name,drive_id SharePoint drive name ID. properties TRUE, use get_item_properties method return item properties instead item. as_data_frame TRUE, return data frame. FALSE (default), return ms_item ms_item_properties object. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. item ms_drive_item class object. Optional path parameters get SharePoint item supplied. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. dest, overwrite, recursive, parallel Parameters passed download method ms_drive_item object. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"Invisibly returns input dest dest parsed input path item properties.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"default value path \"\" , default, SharePoint items downloaded current working directory. Set overwrite = TRUE allow function overwrite existing file. download_sp_file() identical except name path parameter (file instead path). Note, selected item folder recurse = TRUE, may take time download enclosed items Microsoft365R provide progress bar operation.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"batch-downloads-for-sharepoint-items","dir":"Reference","previous_headings":"","what":"Batch downloads for SharePoint items","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"provided vector paths vector item ID values, download_sp_item() can execute batch download set files folders. Make sure supply vector new_path dest vector directory names file names use destination downloads. either option, must supply drive, drive_name site, drive_url. can also pass bare list items value dest can inferred item properties.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"","code":"# Download a single directory sp_dir_url <- \"\" new_path <- \"local file path\" if (is_sp_url(sp_dir_url)) { download_sp_item( sp_dir_url, new_path = new_path, recursive = TRUE ) } # Batch download multiple directories from a SharePoint Drive sp_drive_url <- \"\" if (is_sp_url(sp_drive_url)) { drive <- get_sp_drive(drive_name = sp_drive_url) drive_dir_list <- sp_dir_info( drive = drive, recurse = TRUE, type = \"dir\" ) download_sp_item( item_id = drive_dir_list$id, dest = drive_dir_list$name, recursive = TRUE, drive = drive ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a SharePoint List — download_sp_list","title":"Download a SharePoint List — download_sp_list","text":"Download SharePoint List","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a SharePoint List — download_sp_list","text":"","code":"download_sp_list( ..., sp_list = NULL, fileext = \"csv\", keep_list_cols = c(\"createdBy\", \"lastModifiedBy\"), call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a SharePoint List — download_sp_list","text":"... Arguments passed get_sp_list list_name,list_id SharePoint List name ID string. as_data_frame TRUE, return data frame \"ms_list\" column. get_sp_list() returns 1 row data frame list_sp_lists() returns data frame n rows lists available SharePoint site drive. Defaults FALSE. Ignored metadata = TRUE list metadata always returned data frame. metadata TRUE, get_sp_list() applies get_column_info method returned SharePoint list returns data frame column metadata list. drive_name,drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. site ms_site object. site supplied, site_url, site_name, site_id ignored. sp_list SharePoint list object. supplied, parameters supplied ... ignored. fileext File extension use output file. Must \"csv\" \"xlsx\". keep_list_cols Column names columns maintain list format instead attempting convert character vector.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Get SharePoint group for a site or list group members — get_sp_group","title":"Get SharePoint group for a site or list group members — get_sp_group","text":"get_sp_group() gets group associated individual site using get_group method. list_sp_group_members() lists members group. Note , February 1, 2024, returned member data frame as_data_frame = TRUE contains large number list columns coerced character columns. addressed later update.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get SharePoint group for a site or list group members — get_sp_group","text":"","code":"get_sp_group( site_url = NULL, site_name = NULL, site_id = NULL, ..., site = NULL, call = caller_env() ) list_sp_group_members( site_url = NULL, site_name = NULL, site_id = NULL, ..., as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get SharePoint group for a site or list group members — get_sp_group","text":"site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. ... Additional parameters passed get_sp_site() Microsoft365R::get_sharepoint_site(). site ms_site object. site supplied, site_url, site_name, site_id ignored. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. as_data_frame TRUE (default), converted list members data frame list column named az_user contains member list properties converted columns.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint item or item properties — get_sp_item","title":"Get a SharePoint item or item properties — get_sp_item","text":"get_sp_item() wraps get_item method ms_drive objects returns ms_drive_item object default. get_sp_item_properties() uses get_item_properties method (also available setting properties = TRUE get_sp_item()). Additional parameters ... passed get_sp_drive() get_sp_item() get_sp_item() get_sp_item_properties() delete_sp_item().","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint item or item properties — get_sp_item","text":"","code":"get_sp_item( path = NULL, item_id = NULL, item_url = NULL, ..., drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, properties = FALSE, as_data_frame = FALSE, call = caller_env() ) get_sp_item_properties( path = NULL, item_id = NULL, item_url = NULL, ..., drive = NULL, drive_name = NULL, drive_id = NULL, site_url = NULL, as_data_frame = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint item or item properties — get_sp_item","text":"path SharePoint file URL relative path file located SharePoint drive. input relative path, string include drive name. input shared file URL, text \"Shared \" removed start SharePoint drive name default. file document URL, default_drive_name argument used drive_name item_id extracted URL. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. ... Arguments passed get_sp_drive drive_name,drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). site ms_site object. site supplied, site_url, site_name, site_id ignored. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. properties TRUE, use get_item_properties method return item properties instead item. as_data_frame TRUE, return data frame. FALSE (default), return ms_item ms_item_properties object. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a SharePoint item or item properties — get_sp_item","text":"","code":"sp_item_url <- \"\" if (is_sp_url(sp_item_url)) { get_sp_item( item_url = sp_item_url ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/is_sp_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Is x a SharePoint URL? — is_sp_url","title":"Is x a SharePoint URL? — is_sp_url","text":"x SharePoint URL?","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/is_sp_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is x a SharePoint URL? — is_sp_url","text":"","code":"is_sp_url(x) is_sp_site_url(x) is_sp_doc_url(x) is_sp_type_url(x, type = \"w\") is_sp_folder_url(x)"},{"path":"https://elipousson.github.io/sharepointr/reference/is_sp_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is x a SharePoint URL? — is_sp_url","text":"x Object test URL. type Type URL test .","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_drives.html","id":null,"dir":"Reference","previous_headings":"","what":"List drives for a SharePoint site — list_sp_drives","title":"List drives for a SharePoint site — list_sp_drives","text":"list_sp_drives() loads SharePoint site uses list_drives method returns data frame list column ms_drive objects , as_data_frame = FALSE. helpful drive renamed easily identified using Drive URL alone.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_drives.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List drives for a SharePoint site — list_sp_drives","text":"","code":"list_sp_drives( ..., site = NULL, filter = NULL, n = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_drives.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List drives for a SharePoint site — list_sp_drives","text":"... Arguments passed get_sp_site site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name,site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. refresh TRUE, get new site even existing site cached local option. FALSE, use cached ms_site object. cache TRUE, cache site file using cache_sp_site(). cache_file File name cached file cache = TRUE. Defaults \"sp_site.rds\" option set sharepointr.cache_file_site. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. filter Filter apply query n Max number drives return","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_arg_terms.html","id":null,"dir":"Reference","previous_headings":"","what":"Shared general definitions for Microsoft Graph API parameters — ms_graph_arg_terms","title":"Shared general definitions for Microsoft Graph API parameters — ms_graph_arg_terms","text":"Shared general definitions Microsoft Graph API parameters","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_arg_terms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shared general definitions for Microsoft Graph API parameters — ms_graph_arg_terms","text":"filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_obj_terms.html","id":null,"dir":"Reference","previous_headings":"","what":"Shared general definitions for Microsoft Graph objects — ms_graph_obj_terms","title":"Shared general definitions for Microsoft Graph objects — ms_graph_obj_terms","text":"Shared general definitions Microsoft Graph objects","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_obj_terms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shared general definitions for Microsoft Graph objects — ms_graph_obj_terms","text":"site ms_site object. site supplied, site_url, site_name, site_id ignored. plan ms_plan object. plan supplied, plan_title, plan_id, additional parameters passed ... ignored. sp_list ms_list object. supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, additional parameters passed ... ignored.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_obj_as_data_frame.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","title":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","text":"Convert ms_obj object data frame properties list column objects","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_obj_as_data_frame.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","text":"","code":"ms_obj_as_data_frame( ms_obj, obj_col = \"ms_plan\", recursive = FALSE, keep_list_cols = NULL, unlist_cols = TRUE, .name_repair = \"universal_quiet\", .error_call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/ms_obj_as_data_frame.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","text":"obj_col Column name list column ms_ objects. Defaults \"ms_plan\". keep_list_cols Column names columns maintain list format instead attempting convert character vector.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/read_sharepoint.html","id":null,"dir":"Reference","previous_headings":"","what":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","title":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","text":"read_sharepoint() designed download SharePoint item temporary folder read file based file extension. function provided .f, used read downloaded file. , class returned object depends file extension file parameter. file csv, csv2, tsv file Microsoft Excel file (xlsx xls), readr::read_delim() readxl::read_excel() used return data frame. file rds file, readr::read_rds() used return saved object. file pptx docx file, officer::read_docx() officer::read_pptx() used read file rdocx rpptx object. file \"gpkg\", \"geojson\", \"kml\", \"gdb\", \"shp\" file extension, sf::read_sf() used read file sf data frame. file none file extensions, attempt made read file readr::read_lines().","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/read_sharepoint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","text":"","code":"read_sharepoint( file, ..., .f = NULL, new_path = tempdir(), overwrite = TRUE, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, site_name = NULL, site_id = NULL, site = NULL )"},{"path":"https://elipousson.github.io/sharepointr/reference/read_sharepoint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","text":"file Required. SharePoint shared file URL, document URL, , item_id supplied, file name use combination new_path set dest location filename downloaded item. ... Additional parameters passed one functions identified description supplied .f .f Optional function use read file downloaded SharePoint. new_path Path directory downloaded item. Optional dest supplied. path contains file name, item downloaded using file name instead file name original item. new_path refers nonexistent directory item file, directory silently created using fs::dir_create(). overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. site ms_site object. site supplied, site_url, site_name, site_id ignored.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sharepointr-package.html","id":null,"dir":"Reference","previous_headings":"","what":"sharepointr: Read and Write from SharePoint Sites — sharepointr-package","title":"sharepointr: Read and Write from SharePoint Sites — sharepointr-package","text":"R package extending Microsoft365R make easier read, write, work SharePoint items, lists, plans.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sharepointr-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"sharepointr: Read and Write from SharePoint Sites — sharepointr-package","text":"Maintainer: Eli Pousson eli.pousson@gmail.com (ORCID) [copyright holder]","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create SharePoint folders — sp_dir_create","title":"Create SharePoint folders — sp_dir_create","text":"sp_dir_create() wrapper create_folder method handles character vectors. drive_name folder URL relative TRUE, values path appended file path parsed url.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create SharePoint folders — sp_dir_create","text":"","code":"sp_dir_create( path, ..., drive_name = NULL, drive_id = NULL, drive = NULL, relative = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create SharePoint folders — sp_dir_create","text":"path character vector one paths. ... Arguments passed get_sp_drive drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. relative TRUE drive_name folder URL, values path appended file path parsed url. relative character vector, must length 1 length path appended path vector parent directories. second option takes precedence file path parsed url. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create SharePoint folders — sp_dir_create","text":"","code":"drive_url <- \"\" if (is_sp_url(drive_url)) { sp_dir_create( path = \"parent_folder/subfolder\", drive_name = drive_url ) sp_dir_create( path = c(\"subfolder1\", \"subfolder2\", \"subfolder3\"), relative = \"parent_folder\", drive_name = drive_url ) } dir_url <- \"\" if (is_sp_url(dir_url)) { sp_dir_create( path = c(\"subfolder1\", \"subfolder2\", \"subfolder3\"), drive_name = dir_url, relative = TRUE ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":null,"dir":"Reference","previous_headings":"","what":"List SharePoint files and folders — sp_dir_info","title":"List SharePoint files and folders — sp_dir_info","text":"sp_dir_info() wrapper list_files method additional features based fs::dir_info(). sp_dir_ls() returns character vector yet include support recurse argument. {fs} installed, size column formatted using fs::as_fs_bytes() additional \"type\" factor column added values directory file.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List SharePoint files and folders — sp_dir_info","text":"","code":"sp_dir_info( path = NULL, ..., info = \"partial\", full_names = TRUE, pagesize = 1000, drive_name = NULL, drive_id = NULL, drive = NULL, recurse = FALSE, type = \"any\", regexp = NULL, invert = FALSE, perl = FALSE, call = caller_env() ) sp_dir_ls( path = NULL, ..., full_names = FALSE, pagesize = 1000, drive_name = NULL, drive_id = NULL, drive = NULL, type = \"any\", regexp = NULL, invert = FALSE, perl = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List SharePoint files and folders — sp_dir_info","text":"path Path directory folder. SharePoint folder URLs allowed. NULL, path set default \"/\". ... Arguments passed get_sp_drive drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. info information return: \"partial\", \"name\" \"\". \"partial\", data frame returned containing name, size, ID whether item file folder. \"\", data frame returned containing properties item (can large). full_names TRUE (default), return full file path name item. pagesize Maximum number items return. Defaults 1000. Decrease experiencing timeouts. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. recurse TRUE, get info directory supplied path combine info item info supplied path. type Type item return. Can \"\", \"file\", \"directory\". \"directory\" supported option sp_dir_ls() regexp Regular expression passed grep() used filter paths returned. invert logical. TRUE return indices values elements match. perl logical. Perl-compatible regexps used? call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List SharePoint files and folders — sp_dir_info","text":"","code":"dir_url <- \"\" if (is_sp_url(dir_url)) { sp_dir_info( path = dir_url ) sp_dir_ls( path = dir_url ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_drive.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","title":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","text":"get_sp_drive() wraps get_drive method returns ms_drive object. cache_sp_drive() allows cache default SharePoint drive use functions. Additional parameters ... passed get_sp_drive().","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_drive.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","text":"","code":"get_sp_drive( drive_name = NULL, drive_id = NULL, drive_url = NULL, properties = FALSE, ..., site_url = NULL, site = NULL, default_drive_name = getOption(\"sharepointr.default_drive_name\", \"Documents\"), cache = FALSE, refresh = TRUE, overwrite = FALSE, cache_file = getOption(\"sharepointr.cache_file_drive\", \"sp_drive.rds\"), call = caller_env() ) cache_sp_drive( ..., drive = NULL, cache_file = getOption(\"sharepointr.cache_file_drive\", \"sp_drive.rds\"), overwrite = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_drive.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","text":"drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. properties TRUE, return drive properties instead ms_drive object. Defaults FALSE. ... Arguments passed get_sp_site site_name,site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. drive ms_drive object. drive supplied, drive_name drive_id ignored.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint list or a list of SharePoint lists — sp_list","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"get_sp_list() wrapper get_list list_items methods. function still development support URL parsing used get_sp_item(). list_sp_lists() returns lists SharePoint site drive list data frame. Note, using filter get_sp_list(), names used expression must prefixed \"fields/\" distinguish item metadata.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"","code":"get_sp_list( list_name = NULL, list_id = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, metadata = FALSE, as_data_frame = FALSE, call = caller_env() ) list_sp_lists( site_url = NULL, filter = NULL, n = Inf, ..., site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, as_data_frame = TRUE, call = caller_env() ) get_sp_list_metadata( list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() ) delete_sp_list( list_name = NULL, list_id = NULL, sp_list = NULL, confirm = TRUE, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"list_name, list_id SharePoint List name ID string. ... Arguments passed get_sp_drive drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. metadata TRUE, get_sp_list() applies get_column_info method returned SharePoint list returns data frame column metadata list. as_data_frame TRUE, return data frame \"ms_list\" column. get_sp_list() returns 1 row data frame list_sp_lists() returns data frame n rows lists available SharePoint site drive. Defaults FALSE. Ignored metadata = TRUE list metadata always returned data frame. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf. sp_list ms_list object. supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, additional parameters passed ... ignored. confirm TRUE, confirm deletion list proceeding.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"data frame as_data_frame = TRUE ms_list object (list ms_list objects) FALSE.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Get, list, update, and delete SharePoint list items — sp_list_item","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"list_sp_list_items() lists sp_list items. Additional functions completed get_item, create_item, update_item, delete_item methods documented Microsoft365R::ms_list.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"","code":"list_sp_list_items( list_name = NULL, list_id = NULL, sp_list = NULL, ..., filter = NULL, select = NULL, all_metadata = FALSE, as_data_frame = TRUE, pagesize = 5000, site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() ) get_sp_list_item( id, list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() ) create_sp_list_items( data, list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, check_fields = TRUE, sync_fields = FALSE, strict = FALSE, call = caller_env() ) update_sp_list_item( id, list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"list_name, list_id SharePoint List name ID string. sp_list ms_list object. supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, additional parameters passed ... ignored. ... Arguments passed get_sp_list list_name,list_id SharePoint List name ID string. metadata TRUE, get_sp_list() applies get_column_info method returned SharePoint list returns data frame column metadata list. drive_name,drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. select character vector column names include returned data frame list items. NULL, data frame includes columns list. all_metadata TRUE, returned data frame contain extended metadata separate columns, data fields nested data frame named fields. always set FALSE n = NULL as_data_frame = FALSE. as_data_frame TRUE, return data frame \"ms_list\" column. get_sp_list() returns 1 row data frame list_sp_lists() returns data frame n rows lists available SharePoint site drive. Defaults FALSE. Ignored metadata = TRUE list metadata always returned data frame. pagesize Number list items return. Reduce default 5000 experiencing timeouts. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. id Required. SharePoint list item ID typically integer record number starting 1 first record. data Required. data frame import items supplied identified SharePoint list. check_fields TRUE (default), column names input data matched fields list object. FALSE, function error column names matched field supplied SharePoint list. sync_fields TRUE, use sync_fields method sync fields local sp_list object fields SharePoint List source. strict TRUE, column names data must matched field names supplied SharePoint list. FALSE (default), unmatched columns dropped warning.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"Creating new list items create_sp_list_items() handling item creation column names data match fields names supplied list includes options: names data match fields list, function errors lists field names. names data match fields list records created. fields corresponding names data remain blank. names data match fields list, default, columns dropped adding items list. strict = TRUE names data match fields, function errors.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"","code":"sp_list_url <- \"\" if (is_sp_url(sp_list_url)) { create_sp_list_items( data = data.frame( Name = c(\"Jim\", \"Jane\", \"Jayden\") ), list_name = sp_list_url ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint plan or list SharePoint plans — sp_plan","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"get_sp_plan() returns single ms_plan object using get_plan method. list_sp_plans() returns data frame plan properties list ms_plan objects.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"","code":"get_sp_plan( plan_title = NULL, plan_id = NULL, ..., site = NULL, site_url = NULL, as_data_frame = FALSE, call = caller_env() ) list_sp_plans( ..., filter = NULL, n = NULL, site = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"plan_title, plan_id Planner title ID. Exactly one two arguments must supplied. ... Additional arguments passed get_sp_group(). site ms_site object. site supplied, site_url, site_name, site_id ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. as_data_frame TRUE (default list_sp_plans()), return data frame plan title, id, creation date/time, owner ID list column named \"ms_plan\" containing ms_plan objects. FALSE (default get_sp_plan()), return ms_plan object list ms_plan objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"get_sp_plan(), ms_plan class object 1 row data frame \"ms_plan\" column. list_sp_plans(), list ms_plan class objects data frame list column named \"ms_plan\".","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":null,"dir":"Reference","previous_headings":"","what":"List SharePoint planner buckets — sp_plan_bucket","title":"List SharePoint planner buckets — sp_plan_bucket","text":"list_sp_plan_buckets() lists buckets specified plan using list_buckets method.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List SharePoint planner buckets — sp_plan_bucket","text":"","code":"list_sp_plan_buckets( plan_title = NULL, plan_id = NULL, ..., filter = NULL, n = NULL, plan = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List SharePoint planner buckets — sp_plan_bucket","text":"plan_title, plan_id Planner title ID. Exactly one two arguments must supplied. ... Additional arguments passed get_sp_group(). filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf. plan ms_plan object. plan supplied, plan_title, plan_id, additional parameters passed ... ignored. as_data_frame TRUE (default list_sp_plan_buckets()), return data frame object properties list column named \"ms_plan_bucket\" containing ms_plan_task objects. FALSE, return ms_plan_bucket object list ms_plan_bucket objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List SharePoint planner buckets — sp_plan_bucket","text":"list_sp_plan_buckets(), list ms_plan_bucket class objects data frame list column named \"ms_plan_task\".","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint site or set a default SharePoint site — sp_site","title":"Get a SharePoint site or set a default SharePoint site — sp_site","text":"get_sp_site() wrapper Microsoft365R::get_sharepoint_site() returns ms_site object. cache_sp_site() allows cache default SharePoint site use functions.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint site or set a default SharePoint site — sp_site","text":"","code":"get_sp_site( site_url = NULL, site_name = NULL, site_id = NULL, ..., cache = FALSE, refresh = TRUE, overwrite = FALSE, cache_file = getOption(\"sharepointr.cache_file_site\", \"sp_site.rds\"), call = caller_env() ) cache_sp_site( ..., site = NULL, cache_file = getOption(\"sharepointr.cache_file_site\", \"sp_site.rds\"), cache_dir = \"sharepointr.cache_dir\", overwrite = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint site or set a default SharePoint site — sp_site","text":"site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. ... Arguments passed Microsoft365R::get_sharepoint_site app custom app registration ID use authentication. See . scopes Microsoft Graph scopes (permissions) obtain. never necessary change . token AAD OAuth token object, class AzureAuth::AzureToken. supplied, tenant, app, scopes ... arguments ignored. See \"Authenticating token\" . tenant get_business_onedrive, get_sharepoint_site get_team, name Azure Active Directory (AAD) tenant. supplied, use value CLIMICROSOFT365_TENANT environment variable, \"common\" unset. cache TRUE, cache site file using cache_sp_site(). refresh TRUE, get new site even existing site cached local option. FALSE, use cached ms_site object. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. cache_file File name cached file cache = TRUE. Defaults \"sp_site.rds\" option set sharepointr.cache_file_site. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. site ms_site object. site supplied, site_url, site_name, site_id ignored. cache_dir Cache directory. default, uses environmental variable named \"sharepointr.cache_dir\". \"sharepointr.cache_dir\" set, cache directory set rappdirs::user_cache_dir(\"sharepointr\").","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint task or list tasks from a planner — sp_tasks","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"get_sp_task() gets individual planner task using get_task method. list_sp_tasks() lists tasks specified plan using list_tasks method.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"","code":"get_sp_task( task_title = NULL, task_id = NULL, ..., plan_title = NULL, plan_id = NULL, plan = NULL, as_data_frame = FALSE, call = caller_env() ) list_sp_tasks( plan_title = NULL, plan_id = NULL, ..., filter = NULL, n = NULL, plan = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"task_title, task_id Planner task title id. Exactly one task_title task_id must supplied. ... Additional arguments passed get_sp_group(). plan_title, plan_id Planner title ID. Exactly one two arguments must supplied. plan ms_plan object. plan supplied, plan_title, plan_id, additional parameters passed ... ignored. as_data_frame TRUE (default list_sp_tasks()), return data frame object properties list column named \"ms_plan_task\" containing ms_plan_task objects. FALSE (default get_sp_task()), return ms_plan_task object list ms_plan_task objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"list_sp_tasks(), list ms_plan_task class objects data frame list column named \"ms_plan_task\".","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_url_parse.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","title":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","text":"sp_url_parse() parses URL named list parts. sp_url_parse_hostname() parses hostname tenant base_url. sp_url_parse_hostname() parses hostname path url_type, permissions, site_name, file_path, file. sp_url_parse_hostname() parses query turn sourcedoc value item_id return query values named list.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_url_parse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","text":"","code":"sp_url_parse(url, call = caller_env()) sp_url_parse_hostname(hostname, tenant = \"[a-zA-Z0-9.-]+\", scheme = \"https\") sp_url_parse_path( path, url_type = \"w|x|p|o|b|t|i|v|f|u|li\", permissions = \"r|s|t|u|g\", drive_name_prefix = \"Shared \", default_drive_name = \"Documents\" ) sp_url_parse_query(query)"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_url_parse.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","text":"Types SharePoint URLs SharePoint site URL: https://[tenant].sharepoint.com/sites/[site name] SharePoint document editor URL: https://[tenant].sharepoint.com/:[url type]:/[permissions]/sites/[site name]/_layouts/15/Doc.aspx?sourcedoc=[item id]&file=[file name]&[additional query parameters] SharePoint List URL: https://[tenant].sharepoint.com/sites/[site name]/Lists/[list name]/AllItems.aspx?env=WebViewList https://[tenant].sharepoint.com/:l:/r/sites/[site name]/Lists/[list name] SharePoint folder URL: https://[tenant].sharepoint.com/:[url type]:/[permissions]/sites/[site name]/[drive name (possible \"Shared\" prefix)]/[folder path]/[folder name]/?[additional query parameters] SharePoint Planner URL: https://tasks.office.com/[tenant].onmicrosoft.com/en-US/Home/Planner/#/plantaskboard?groupId=[Group ID]&planId=[Plan ID]","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/upload_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload a file or folder to a SharePoint Drive — upload_sp_item","title":"Upload a file or folder to a SharePoint Drive — upload_sp_item","text":"upload_sp_item() wraps upload_folder upload_file method ms_drive objects.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/upload_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload a file or folder to a SharePoint Drive — upload_sp_item","text":"","code":"upload_sp_item( file = NULL, dest, ..., src = NULL, overwrite = FALSE, drive_name = NULL, drive_id = NULL, drive = NULL, blocksize = 327680000, recursive = FALSE, parallel = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/upload_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload a file or folder to a SharePoint Drive — upload_sp_item","text":"file Path file directory upload. Optional src supplied. dest Destination SharePoint file upload. SharePoint folder URLs supported. ... Additional parameters passed get_sp_site() Microsoft365R::get_sharepoint_site(). src Data source path passed upload_folder upload_file method. Defaults NULL set use file value default. overwrite FALSE (default), error item name specified file src already exists specified destination. TRUE, overwrite existing items name. latter default upload_file method. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. blocksize, recursive, parallel Additional parameters passed upload_folder upload_file method ms_drive objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":null,"dir":"Reference","previous_headings":"","what":"Write an object to file and upload file to SharePoint — write_sharepoint","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"write_sharepoint() uses upload_sp_item() upload object created using: sf::write_sf() x sf object readr::write_csv() x data.frame file include xlsx extension openxlsx2::write_xlsx() x data.frame file include xlsx extension print() method {officer} x rdocx, rpptx, rxlsx object readr::write_rds() x class","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"","code":"write_sharepoint( x, file, dest, ..., .f = NULL, new_path = tempdir(), overwrite = FALSE, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, site_name = NULL, site_id = NULL, site = NULL, blocksize = 327680000, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"x Object write file upload SharePoint. sf, rdocx, rpptx, rxlsx, data.frame objects saved functions noted description. object types saved rds outputs. file File write . Passed file parameter readr::write_csv() readr::write_rds(), dsn sf::write_sf(), target print() (working {officer} class objects). dest Destination SharePoint file upload. SharePoint folder URLs supported. ... Additional parameters passed write function. .f Optional function write input data disk uploading file SharePoint. new_path Path write file . Defaults tempdir() overwrite FALSE (default), error item name specified file src already exists specified destination. TRUE, overwrite existing items name. latter default upload_file method. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. site ms_site object. site supplied, site_url, site_name, site_id ignored. blocksize Additional parameter passed upload_folder upload_file method ms_drive objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"Invisibly returns input object x.","code":""}] +[{"path":"https://elipousson.github.io/sharepointr/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 sharepointr authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://elipousson.github.io/sharepointr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Eli Pousson. Author, maintainer, copyright holder.","code":""},{"path":"https://elipousson.github.io/sharepointr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Pousson E (2024). sharepointr: Read Write SharePoint Sites. R package version 0.1.0, https://elipousson.github.io/sharepointr/, https://github.com/elipousson/sharepointr.","code":"@Manual{, title = {sharepointr: Read and Write from SharePoint Sites}, author = {Eli Pousson}, year = {2024}, note = {R package version 0.1.0, https://elipousson.github.io/sharepointr/}, url = {https://github.com/elipousson/sharepointr}, }"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"sharepointr","dir":"","previous_headings":"","what":"Read and Write from SharePoint Sites","title":"Read and Write from SharePoint Sites","text":"goal SharePointR make easier read, write, work files stored SharePoint extending Microsoft365R package.","code":""},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Read and Write from SharePoint Sites","text":"can install development version SharePointR like :","code":"# pak::pkg_install(\"elipousson/sharepointr\")"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"requirements","dir":"","previous_headings":"","what":"Requirements","title":"Read and Write from SharePoint Sites","text":"use package ({Microsoft365}) must: work school account access Microsoft SharePoint enabled permissions default {Microsoft365} app ID See {Microsoft365} documentation app registration information.","code":""},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Read and Write from SharePoint Sites","text":"{Microsoft365} uses S6 methods nearly everything may difficult users (included) less familiar interface. sharepointr package seeks ease challenge wrapping {Microsoft365} methods adding support specification SharePoint sites, drives, items using SharePoint URLs instead item drive ID values.","code":"library(sharepointr)"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"reading-and-writing-objects-to-and-from-sharepoint","dir":"","previous_headings":"Usage","what":"Reading and writing objects to and from SharePoint","title":"Read and Write from SharePoint Sites","text":"useful functions users may read_sharepoint() write_sharepoint(). read_sharepoint() downloads SharePoint file temporary folder , based file extension, reads environment using appropriate function package (e.g. using officer::read_docx() Microsoft Word files sf::read_sf() common spatial data files): write_sharepoint() saves R object local files uses upload_sp_item() uploads file SharePoint. plan adding features allow custom mapping file extensions object classes specific functions packages adding thorough documentation. Feel free submit issue make pull request ideas .","code":"docx_shared_url <- \"https://bmore.sharepoint.com/:w:/r/sites/MayorsOffice-DataGovernance/Shared%20Documents/General/Baltimore%20Data%20Academy/Baltimore%20Data%20Academy%20Announcement%20Content.docx?d=w0a50d3cd74ce4a8da6d82596037f0148&csf=1&web=1&e=cBURo2\" read_sharepoint(docx_shared_url) #> Loading Microsoft Graph login for default tenant #> ℹ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000g… #> ✔ Downloading SharePoint item to '/var/folders/3f/50m42dx1333_dfqb5772j6_40000g… #> #> ℹ Reading item with `officer::read_docx()` #> ✔ Reading item with `officer::read_docx()` [41ms] #> #> rdocx document with 19 element(s) #> #> * styles: #> Normal Default Paragraph Font Normal Table #> \"paragraph\" \"character\" \"table\" #> No List List Paragraph annotation reference #> \"numbering\" \"paragraph\" \"character\" #> annotation text Comment Text Char annotation subject #> \"paragraph\" \"character\" \"paragraph\" #> Comment Subject Char Hyperlink Unresolved Mention #> \"character\" \"character\" \"character\" #> #> * Content at cursor location: #> level num_id #> 1 NA NA #> text #> 1 If you have questions or feedback about the program, contact Chief Data Officer Justin Elszasz at justin.elszasz@baltimorecity.gov. Happy learning! #> style_name content_type #> 1 NA paragraph"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"working-with-sharepoint-items-lists-and-plans","dir":"","previous_headings":"Usage","what":"Working with SharePoint items, lists, and plans","title":"Read and Write from SharePoint Sites","text":"package currently support three main categories SharePoint objects: Items (including directories files) item properties Lists list items Plans tasks Typically functions return ms_object object, list ms_object objects, data frame. cases, data frame based object properties includes list column ms_object stored. example, get_sp_item() returns ms_drive_item object supports parsing shared file folder URLs: Set as_data_frame = TRUE return data frame instead ms_drive_item object: basic functions “get” objects extended functions like download_sp_item() adds support downloading copies SharePoint files (function powers read_sharepoint()): original Microsoft365R S6 object methods already return data frame default sp_dir_info(): Others use as_data_frame parameter convert list data frame convenient alternative.","code":"get_sp_item(docx_shared_url) #> Loading Microsoft Graph login for default tenant #> #> directory id: 017P4HV6ON2NIAVTTURVFKNWBFSYBX6AKI #> web link: https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/_layouts/15/Doc.aspx?sourcedoc=%7B0A50D3CD-74CE-4A8D-A6D8-2596037F0148%7D&file=Baltimore%20Data%20Academy%20Announcement%20Content.docx&action=default&mobileredirect=true #> type: file #> --- #> Methods: #> copy, create_folder, create_share_link, delete, #> do_operation, download, get_item, get_list_pager, #> get_parent_folder, get_path, is_folder, list_files, #> list_items, load_dataframe, load_rdata, load_rds, move, #> open, save_dataframe, save_rdata, save_rds, sync_fields, #> update, upload get_sp_item(docx_shared_url, as_data_frame = TRUE) #> Loading Microsoft Graph login for default tenant #> @odata.context #> 1 https://graph.microsoft.com/beta/$metadata#drives('b%21txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO')/root/$entity #> @microsoft.graph.downloadUrl #> 1 https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/_layouts/15/download.aspx?UniqueId=0a50d3cd-74ce-4a8d-a6d8-2596037f0148&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvYm1vcmUuc2hhcmVwb2ludC5jb21AMzEyY2IxMjYtYzZhZS00ZmMyLTgwMGQtMzE4ZTY3OWNlNmM3IiwiaXNzIjoiMDAwMDAwMDMtMDAwMC0wZmYxLWNlMDAtMDAwMDAwMDAwMDAwIiwibmJmIjoiMTcwNjc1NDU1NyIsImV4cCI6IjE3MDY3NTgxNTciLCJlbmRwb2ludHVybCI6ImVWS1o5aHllbHVsNU9PdzR6OWQ1U01sOVBkZXpXTjNOU3NscWxGM3V2ME09IiwiZW5kcG9pbnR1cmxMZW5ndGgiOiIxNTAiLCJpc2xvb3BiYWNrIjoiVHJ1ZSIsImNpZCI6ImlUQVg3bGRUOWtDZy83UE5venJGV2c9PSIsInZlciI6Imhhc2hlZHByb29mdG9rZW4iLCJzaXRlaWQiOiJNV1JoTURGallqY3ROelpqTnkwME5EZzNMV0l6T1RndFpXTTJNR1JtWmpobU5USmsiLCJhcHBfZGlzcGxheW5hbWUiOiJBenVyZVIvTWljcm9zb2Z0MzY1UiIsImdpdmVuX25hbWUiOiJFbGkiLCJmYW1pbHlfbmFtZSI6IlBvdXNzb24iLCJhcHBpZCI6ImQ0NGEwNWQ1LWM2YTUtNGJiYi04MmQyLTQ0MzEyMzcyMjM4MCIsInRpZCI6IjMxMmNiMTI2LWM2YWUtNGZjMi04MDBkLTMxOGU2NzljZTZjNyIsInVwbiI6ImVsaS5wb3Vzc29uQGJhbHRpbW9yZWNpdHkuZ292IiwicHVpZCI6IjEwMDMyMDAxRkQ3Q0UxMjQiLCJjYWNoZWtleSI6IjBoLmZ8bWVtYmVyc2hpcHwxMDAzMjAwMWZkN2NlMTI0QGxpdmUuY29tIiwic2NwIjoiZ3JvdXAud3JpdGUgYWxsc2l0ZXMubWFuYWdlIGFsbHNpdGVzLndyaXRlIiwidHQiOiIyIiwiaXBhZGRyIjoiMjAuMTkwLjE1MS4zNyJ9.EP15oZ01FLz_6tPq0kgN3JLliBIPtAg3aYhscvPfpic&ApiVersion=2.0 #> createdDateTime eTag #> 1 2023-01-13T16:42:07Z \"{0A50D3CD-74CE-4A8D-A6D8-2596037F0148},57\" #> id lastModifiedDateTime #> 1 017P4HV6ON2NIAVTTURVFKNWBFSYBX6AKI 2023-01-26T18:17:57Z #> name #> 1 Baltimore Data Academy Announcement Content.docx #> webUrl #> 1 https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/_layouts/15/Doc.aspx?sourcedoc=%7B0A50D3CD-74CE-4A8D-A6D8-2596037F0148%7D&file=Baltimore%20Data%20Academy%20Announcement%20Content.docx&action=default&mobileredirect=true #> cTag size #> 1 \"c:{0A50D3CD-74CE-4A8D-A6D8-2596037F0148},141\" 79504 #> createdBy #> 1 Justin.Elszasz@baltimorecity.gov, a43c19f9-9a13-403d-9234-0c13f4e84b1c, Elszasz, Justin #> lastModifiedBy #> 1 Michael.Gottlieb@baltimorecity.gov, a2dedf36-3fce-4998-92f5-9350e749769f, Gottlieb, Michael (BCIT) #> shared #> 1 users #> parentReference #> 1 documentLibrary, b!txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO, 017P4HV6NGOMGBBVI5GBBZU5BFDTPDKJ7W, Baltimore Data Academy, /drives/b!txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO/root:/General/Baltimore Data Academy, 1da01cb7-76c7-4487-b398-ec60dff8f52d #> file #> 1 application/vnd.openxmlformats-officedocument.wordprocessingml.document, HXogYD+5fQrvr/nsAemsu10d62M= #> fileSystemInfo ms_item #> 1 2023-01-13T16:42:07Z, 2023-01-26T18:17:57Z withr::with_tempdir({ docx_dest <- download_sp_item(docx_shared_url) file.exists(docx_dest) }) #> Loading Microsoft Graph login for default tenant #> ℹ Downloading SharePoint item to 'Baltimore Data Academy Announcement Content.d… #> ✔ Downloading SharePoint item to 'Baltimore Data Academy Announcement Content.d… #> #> [1] TRUE sp_dir_info(\"https://bmore.sharepoint.com/:w:/r/sites/MayorsOffice-DataGovernance/Shared%20Documents/General/Baltimore%20Data%20Academy\") #> Loading Microsoft Graph login for default tenant #> name #> 1 General/Baltimore Data Academy/Logos #> 2 General/Baltimore Data Academy/BALT 02 Interpreting Data - Student Coursebook.pdf #> 3 General/Baltimore Data Academy/BALT 03_Leading with Data_Workday Lesson 1_03292023.pdf #> 4 General/Baltimore Data Academy/BALT 04_Data Stewardship_Workday Lesson 1_03292023.pdf #> 5 General/Baltimore Data Academy/BALT 05_Measuring Government Performance_Course Access Instructions_Workday Lesson 1_02282023.pdf #> 6 General/Baltimore Data Academy/Baltimore Data Academy Announcement Content.docx #> 7 General/Baltimore Data Academy/Baltimore Data Academy New Course Announcement 7.11.23.docx #> 8 General/Baltimore Data Academy/Curriculum One Pager.pdf #> 9 General/Baltimore Data Academy/Document.docx #> 10 General/Baltimore Data Academy/Foundations of Data Literacy_2023 [43].pdf #> 11 General/Baltimore Data Academy/Interpreting Data with Greater Accuracy and Insight[97].pdf #> 12 General/Baltimore Data Academy/Last SR by Agency as of 7.11.23.xlsx #> size isdir id type #> 1 3.26M TRUE 017P4HV6I3IGKTFCO2FZD3FXPCGUPJSO6G directory #> 2 703.38K FALSE 017P4HV6KITC7MJJJESFD35BIDU5DR4BSL file #> 3 388.91K FALSE 017P4HV6N2LBZHX6ERCBCIQRJIXGTZMYCK file #> 4 389.67K FALSE 017P4HV6ICFKFITU4WC5CYAFJUTZAMHP7K file #> 5 391.34K FALSE 017P4HV6MQCBPQQD6VUVCJWMWAKTIBZNYQ file #> 6 77.64K FALSE 017P4HV6ON2NIAVTTURVFKNWBFSYBX6AKI file #> 7 53.98K FALSE 017P4HV6PKOSFTLSMOAJDK3OGKFUVCIICU file #> 8 88.45K FALSE 017P4HV6OKNLH7UWTQJBEZXWNFXBGBC6OC file #> 9 48.51K FALSE 017P4HV6L5XTQ7IOMVYBGKSYMSOYDXMMPZ file #> 10 536.85K FALSE 017P4HV6KALORFIRC2IBB3RN52WE4V7QGU file #> 11 618.2K FALSE 017P4HV6NWPAN6PTWC3FEJB3KRR2WDWXFM file #> 12 18.51K FALSE 017P4HV6K2WP2LBTN6PFGLVY4PIWOY7IAR file"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"helpers-for-sharepoint-sites-and-drives","dir":"","previous_headings":"Usage","what":"Helpers for SharePoint sites and drives","title":"Read and Write from SharePoint Sites","text":"functions package rely pair helper functions: get_sp_site(), get_sp_drive(), get_sp_item(), can parse URL determine SharePoint site URL, drive name, file path based URL. get_sp_site() minimal wrapper Microsoft365R::get_sharepoint_site(): get_sp_drive() returns ms_drive object required SharePoint URL includes name drive (otherwise returns drive named “sharepointr.default_drive_name” option):","code":"site_url <- \"https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance\" get_sp_site(site_url = site_url) #> Loading Microsoft Graph login for default tenant #> #> directory id: bmore.sharepoint.com,1da01cb7-76c7-4487-b398-ec60dff8f52d,7abe409a-2aeb-4eb8-8dc3-8fe9106907af #> web link: https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance #> description: If you work with or are interested in data, feel free to join! #> --- #> Methods: #> delete, do_operation, get_drive, get_group, get_list, #> get_list_pager, get_lists, list_drives, list_subsites, #> sync_fields, update get_sp_drive(docx_shared_url) #> Loading Microsoft Graph login for default tenant #> #> directory id: b!txygHcd2h0SzmOxg3_j1LZpAvnrrKrhOjcOP6RBpB6-8Kta613N3QJlbvrVKyTwO #> web link: https://bmore.sharepoint.com/sites/MayorsOffice-DataGovernance/Shared%20Documents #> description: #> --- #> Methods: #> copy_item, create_folder, create_share_link, delete, #> delete_item, do_operation, download_file, download_folder, #> get_item, get_item_properties, get_list_pager, list_files, #> list_items, list_shared_files, list_shared_items, #> load_dataframe, load_rdata, load_rds, move_item, open_item, #> save_dataframe, save_rdata, save_rds, set_item_properties, #> sync_fields, update, upload_file, upload_folder"},{"path":"https://elipousson.github.io/sharepointr/index.html","id":"related-packages","dir":"","previous_headings":"","what":"Related packages","title":"Read and Write from SharePoint Sites","text":"similar packages available: sharrpoint: R package interact Sharepoint API (files & lists). sharepointr: R package reading writing SharePoint lists. msgraphr: minimal R wrapper SharePoint Online (Office 365) APIs (last updated 3 years ago). know package name conflicts existing sharepointr package. Unfortunately, didn’t notice find set repository. However, given appears sharepointr package may longer development, plan stick current name time .","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/AzureR_config.html","id":null,"dir":"Reference","previous_headings":"","what":"List or delete files from the AzureR configuration directory — AzureR_config","title":"List or delete files from the AzureR configuration directory — AzureR_config","text":"AzureR_config_ls() uses rappdirs::user_config_dir() fs::dir_ls() list files AzureR configuration directory. AzureR_config_delete() uses fs::file_delete() remove \"graph_logins.json\" configuration file needed. Use function caution may option address \"Unable refresh token\" error.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/AzureR_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List or delete files from the AzureR configuration directory — AzureR_config","text":"","code":"AzureR_config_ls(path = NULL, glob = \"*.json\") AzureR_config_delete(path = NULL, filename = \"graph_logins.json\")"},{"path":"https://elipousson.github.io/sharepointr/reference/AzureR_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List or delete files from the AzureR configuration directory — AzureR_config","text":"path Path configuration directory AzureR package JSON file graph_logins stored. NULL, path set rappdirs::user_config_dir(\"AzureR\"). glob wildcard aka globbing pattern (e.g. *.csv) passed grep() filter paths. filename Filename delete configuration directory. Defaults \"graph_logins.json\". Set NULL path contains file name.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/cache_ms_obj.html","id":null,"dir":"Reference","previous_headings":"","what":"Cache a ms_object class object to a file — cache_ms_obj","title":"Cache a ms_object class object to a file — cache_ms_obj","text":"Cache ms_object class object file","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/cache_ms_obj.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cache a ms_object class object to a file — cache_ms_obj","text":"","code":"cache_ms_obj( x, cache_file, cache_dir = NULL, what = \"ms_site\", overwrite = FALSE, arg = caller_arg(x), call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/cache_ms_obj.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cache a ms_object class object to a file — cache_ms_obj","text":"cache_file File name cached file. Required. cache_dir Cache directory. default, uses environmental variable named \"sharepointr.cache_dir\". \"sharepointr.cache_dir\" set, cache directory set rappdirs::user_cache_dir(\"sharepointr\"). overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete SharePoint items (files and directories) — delete_sp_item","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"delete_sp_item() deletes items including files directories using delete method . default confirm = TRUE, requires user respond prompt: \"really want delete drive item ...? (yes//cancel)\" continue.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"","code":"delete_sp_item( path = NULL, confirm = TRUE, by_item = FALSE, ..., item_id = NULL, item_url = NULL, item = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"path SharePoint file URL relative path file located SharePoint drive. input relative path, string include drive name. input shared file URL, text \"Shared \" removed start SharePoint drive name default. file document URL, default_drive_name argument used drive_name item_id extracted URL. confirm TRUE, confirm deleting item. TRUE session interactive, function error. by_item business OneDrive SharePoint document libraries, may need set by_item = TRUE delete contents folder depending policies set SharePoint administrator policies. Note, method can slow large folders. ... Arguments passed get_sp_item drive_name,drive_id SharePoint drive name ID. as_data_frame TRUE, return data frame. FALSE (default), return ms_item ms_item_properties object. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. item ms_drive_item class object. Optional path parameters get SharePoint item supplied. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/delete_sp_item.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete SharePoint items (files and directories) — delete_sp_item","text":"Trouble-shooting errors get error: \"resource attempting access locked\", another user may file file within directory open editing. Close file try deleting item . get error: \"Request cancelled event received. attempting delete non-empty folder, possible hold.\" set by_item = TRUE try .","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Download one or more items from SharePoint to a file or folder — download_sp_item","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"download_sp_item() wraps download method SharePoint items making easier download items based shared file URL document URL.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"","code":"download_sp_item( path = NULL, new_path = \"\", ..., item_id = NULL, item_url = NULL, item = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, dest = NULL, overwrite = FALSE, recursive = FALSE, parallel = FALSE, call = caller_env() ) download_sp_file(file, new_path = \"\", ..., call = caller_env())"},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"path, file Required. SharePoint shared file URL, document URL, , item_id supplied, file name use path set dest location filename downloaded item. new_path Path directory downloaded item. Optional dest supplied. path contains file name, item downloaded using file name instead file name original item. new_path refers nonexistent directory item file, directory silently created using fs::dir_create(). ... Arguments passed get_sp_item drive_name,drive_id SharePoint drive name ID. properties TRUE, use get_item_properties method return item properties instead item. as_data_frame TRUE, return data frame. FALSE (default), return ms_item ms_item_properties object. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. item ms_drive_item class object. Optional path parameters get SharePoint item supplied. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. dest, overwrite, recursive, parallel Parameters passed download method ms_drive_item object. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"Invisibly returns input dest dest parsed input path item properties.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"default value path \"\" , default, SharePoint items downloaded current working directory. Set overwrite = TRUE allow function overwrite existing file. download_sp_file() identical except name path parameter (file instead path). Note, selected item folder recurse = TRUE, may take time download enclosed items Microsoft365R provide progress bar operation.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"batch-downloads-for-sharepoint-items","dir":"Reference","previous_headings":"","what":"Batch downloads for SharePoint items","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"provided vector paths vector item ID values, download_sp_item() can execute batch download set files folders. Make sure supply vector new_path dest vector directory names file names use destination downloads. either option, must supply drive, drive_name site, drive_url. can also pass bare list items value dest can inferred item properties.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download one or more items from SharePoint to a file or folder — download_sp_item","text":"","code":"# Download a single directory sp_dir_url <- \"\" new_path <- \"local file path\" if (is_sp_url(sp_dir_url)) { download_sp_item( sp_dir_url, new_path = new_path, recursive = TRUE ) } # Batch download multiple directories from a SharePoint Drive sp_drive_url <- \"\" if (is_sp_url(sp_drive_url)) { drive <- get_sp_drive(drive_name = sp_drive_url) drive_dir_list <- sp_dir_info( drive = drive, recurse = TRUE, type = \"dir\" ) download_sp_item( item_id = drive_dir_list$id, dest = drive_dir_list$name, recursive = TRUE, drive = drive ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a SharePoint List — download_sp_list","title":"Download a SharePoint List — download_sp_list","text":"Download SharePoint List","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a SharePoint List — download_sp_list","text":"","code":"download_sp_list( ..., sp_list = NULL, fileext = \"csv\", keep_list_cols = c(\"createdBy\", \"lastModifiedBy\"), call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/download_sp_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a SharePoint List — download_sp_list","text":"... Arguments passed get_sp_list list_name,list_id SharePoint List name ID string. as_data_frame TRUE, return data frame \"ms_list\" column. get_sp_list() returns 1 row data frame list_sp_lists() returns data frame n rows lists available SharePoint site drive. Defaults FALSE. Ignored metadata = TRUE list metadata always returned data frame. metadata TRUE, get_sp_list() applies get_column_info method returned SharePoint list returns data frame column metadata list. drive_name,drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. site ms_site object. site supplied, site_url, site_name, site_id ignored. sp_list SharePoint list object. supplied, parameters supplied ... ignored. fileext File extension use output file. Must \"csv\" \"xlsx\". keep_list_cols Column names columns maintain list format instead attempting convert character vector.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Get SharePoint group for a site or list group members — get_sp_group","title":"Get SharePoint group for a site or list group members — get_sp_group","text":"get_sp_group() gets group associated individual site using get_group method. list_sp_group_members() lists members group. Note , February 1, 2024, returned member data frame as_data_frame = TRUE contains large number list columns coerced character columns. addressed later update.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get SharePoint group for a site or list group members — get_sp_group","text":"","code":"get_sp_group( site_url = NULL, site_name = NULL, site_id = NULL, ..., site = NULL, call = caller_env() ) list_sp_group_members( site_url = NULL, site_name = NULL, site_id = NULL, ..., as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get SharePoint group for a site or list group members — get_sp_group","text":"site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. ... Additional parameters passed get_sp_site() Microsoft365R::get_sharepoint_site(). site ms_site object. site supplied, site_url, site_name, site_id ignored. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. as_data_frame TRUE (default), converted list members data frame list column named az_user contains member list properties converted columns.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint item or item properties — get_sp_item","title":"Get a SharePoint item or item properties — get_sp_item","text":"get_sp_item() wraps get_item method ms_drive objects returns ms_drive_item object default. get_sp_item_properties() uses get_item_properties method (also available setting properties = TRUE get_sp_item()). Additional parameters ... passed get_sp_drive() get_sp_item() get_sp_item() get_sp_item_properties() delete_sp_item().","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint item or item properties — get_sp_item","text":"","code":"get_sp_item( path = NULL, item_id = NULL, item_url = NULL, ..., drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, properties = FALSE, as_data_frame = FALSE, call = caller_env() ) get_sp_item_properties( path = NULL, item_id = NULL, item_url = NULL, ..., drive = NULL, drive_name = NULL, drive_id = NULL, site_url = NULL, as_data_frame = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint item or item properties — get_sp_item","text":"path SharePoint file URL relative path file located SharePoint drive. input relative path, string include drive name. input shared file URL, text \"Shared \" removed start SharePoint drive name default. file document URL, default_drive_name argument used drive_name item_id extracted URL. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. ... Arguments passed get_sp_drive drive_name,drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). site ms_site object. site supplied, site_url, site_name, site_id ignored. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. properties TRUE, use get_item_properties method return item properties instead item. as_data_frame TRUE, return data frame. FALSE (default), return ms_item ms_item_properties object. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/get_sp_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a SharePoint item or item properties — get_sp_item","text":"","code":"sp_item_url <- \"\" if (is_sp_url(sp_item_url)) { get_sp_item( item_url = sp_item_url ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/is_sp_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Is x a SharePoint URL? — is_sp_url","title":"Is x a SharePoint URL? — is_sp_url","text":"x SharePoint URL?","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/is_sp_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is x a SharePoint URL? — is_sp_url","text":"","code":"is_sp_url(x) is_sp_site_url(x) is_sp_site_page_url(x) is_sp_doc_url(x) is_sp_type_url(x, type = \"w\") is_sp_folder_url(x)"},{"path":"https://elipousson.github.io/sharepointr/reference/is_sp_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is x a SharePoint URL? — is_sp_url","text":"x Object test URL. type Type URL test .","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_drives.html","id":null,"dir":"Reference","previous_headings":"","what":"List drives for a SharePoint site — list_sp_drives","title":"List drives for a SharePoint site — list_sp_drives","text":"list_sp_drives() loads SharePoint site uses list_drives method returns data frame list column ms_drive objects , as_data_frame = FALSE. helpful drive renamed easily identified using Drive URL alone.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_drives.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List drives for a SharePoint site — list_sp_drives","text":"","code":"list_sp_drives( ..., site = NULL, filter = NULL, n = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_drives.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List drives for a SharePoint site — list_sp_drives","text":"... Arguments passed get_sp_site site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name,site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. refresh TRUE, get new site even existing site cached local option. FALSE, use cached ms_site object. cache TRUE, cache site file using cache_sp_site(). cache_file File name cached file cache = TRUE. Defaults \"sp_site.rds\" option set sharepointr.cache_file_site. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. filter Filter apply query n Max number drives return","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_item_versions.html","id":null,"dir":"Reference","previous_headings":"","what":"List versions for a SharePoint item — list_sp_item_versions","title":"List versions for a SharePoint item — list_sp_item_versions","text":"implementation new method ms_item object using do_operation method directly. intent add list_versions method back Microsoft365R package may include changes functionality output function.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_item_versions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List versions for a SharePoint item — list_sp_item_versions","text":"","code":"list_sp_item_versions(..., sp_item = NULL, as_data_frame = TRUE)"},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_item_versions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List versions for a SharePoint item — list_sp_item_versions","text":"... Arguments passed get_sp_item path SharePoint file URL relative path file located SharePoint drive. input relative path, string include drive name. input shared file URL, text \"Shared \" removed start SharePoint drive name default. file document URL, default_drive_name argument used drive_name item_id extracted URL. item_id SharePoint item ID passed itemid parameter get_item method ms_drive objects. drive_name,drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. properties TRUE, use get_item_properties method return item properties instead item. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. sp_item SharePoint item get versions . Additional parameters passed ... ignored sp_item supplied. as_data_frame TRUE, return data frame versions. FALSE, return list.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_item_versions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List versions for a SharePoint item — list_sp_item_versions","text":"data frame as_data_frame = TRUE list FALSE.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_pages.html","id":null,"dir":"Reference","previous_headings":"","what":"List SharePoint pages or get a single SharePoint page — list_sp_pages","title":"List SharePoint pages or get a single SharePoint page — list_sp_pages","text":"List SharePoint pages get single SharePoint page","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_pages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List SharePoint pages or get a single SharePoint page — list_sp_pages","text":"","code":"list_sp_pages( ..., site = NULL, page_type = c(\"sitePage\", \"page\"), as_data_frame = TRUE ) get_sp_page(page_url = NULL, page_id = NULL, ..., site = NULL)"},{"path":"https://elipousson.github.io/sharepointr/reference/list_sp_pages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List SharePoint pages or get a single SharePoint page — list_sp_pages","text":"... Arguments passed get_sp_site site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name,site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. refresh TRUE, get new site even existing site cached local option. FALSE, use cached ms_site object. cache TRUE, cache site file using cache_sp_site(). cache_file File name cached file cache = TRUE. Defaults \"sp_site.rds\" option set sharepointr.cache_file_site. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. page_type c(\"sitePage\", \"page\")","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_arg_terms.html","id":null,"dir":"Reference","previous_headings":"","what":"Shared general definitions for Microsoft Graph API parameters — ms_graph_arg_terms","title":"Shared general definitions for Microsoft Graph API parameters — ms_graph_arg_terms","text":"Shared general definitions Microsoft Graph API parameters","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_arg_terms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shared general definitions for Microsoft Graph API parameters — ms_graph_arg_terms","text":"filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_obj_terms.html","id":null,"dir":"Reference","previous_headings":"","what":"Shared general definitions for Microsoft Graph objects — ms_graph_obj_terms","title":"Shared general definitions for Microsoft Graph objects — ms_graph_obj_terms","text":"Shared general definitions Microsoft Graph objects","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_graph_obj_terms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shared general definitions for Microsoft Graph objects — ms_graph_obj_terms","text":"site ms_site object. site supplied, site_url, site_name, site_id ignored. plan ms_plan object. plan supplied, plan_title, plan_id, additional parameters passed ... ignored. sp_list ms_list object. supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, additional parameters passed ... ignored.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_obj_as_data_frame.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","title":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","text":"Convert ms_obj object data frame properties list column objects","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/ms_obj_as_data_frame.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","text":"","code":"ms_obj_as_data_frame( ms_obj, obj_col = \"ms_plan\", recursive = FALSE, keep_list_cols = NULL, unlist_cols = TRUE, .name_repair = \"universal_quiet\", .error_call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/ms_obj_as_data_frame.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a ms_obj object to a data frame of properties with a list column of objects — ms_obj_as_data_frame","text":"obj_col Column name list column ms_ objects. Defaults \"ms_plan\". keep_list_cols Column names columns maintain list format instead attempting convert character vector.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/read_sharepoint.html","id":null,"dir":"Reference","previous_headings":"","what":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","title":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","text":"read_sharepoint() designed download SharePoint item temporary folder read file based file extension. function provided .f, used read downloaded file. , class returned object depends file extension file parameter. file csv, csv2, tsv file Microsoft Excel file (xlsx xls), readr::read_delim() readxl::read_excel() used return data frame. file rds file, readr::read_rds() used return saved object. file pptx docx file, officer::read_docx() officer::read_pptx() used read file rdocx rpptx object. file \"gpkg\", \"geojson\", \"kml\", \"gdb\", \"shp\" file extension, sf::read_sf() used read file sf data frame. file none file extensions, attempt made read file readr::read_lines().","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/read_sharepoint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","text":"","code":"read_sharepoint( file, ..., .f = NULL, new_path = tempdir(), overwrite = TRUE, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, site_name = NULL, site_id = NULL, site = NULL )"},{"path":"https://elipousson.github.io/sharepointr/reference/read_sharepoint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read a SharePoint item based on a file URL or file name and site details — read_sharepoint","text":"file Required. SharePoint shared file URL, document URL, , item_id supplied, file name use combination new_path set dest location filename downloaded item. ... Additional parameters passed one functions identified description supplied .f .f Optional function use read file downloaded SharePoint. new_path Path directory downloaded item. Optional dest supplied. path contains file name, item downloaded using file name instead file name original item. new_path refers nonexistent directory item file, directory silently created using fs::dir_create(). overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. site ms_site object. site supplied, site_url, site_name, site_id ignored.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sharepointr-package.html","id":null,"dir":"Reference","previous_headings":"","what":"sharepointr: Read and Write from SharePoint Sites — sharepointr-package","title":"sharepointr: Read and Write from SharePoint Sites — sharepointr-package","text":"R package extending Microsoft365R make easier read, write, work SharePoint items, lists, plans.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sharepointr-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"sharepointr: Read and Write from SharePoint Sites — sharepointr-package","text":"Maintainer: Eli Pousson eli.pousson@gmail.com (ORCID) [copyright holder]","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create SharePoint folders — sp_dir_create","title":"Create SharePoint folders — sp_dir_create","text":"sp_dir_create() wrapper create_folder method handles character vectors. drive_name folder URL relative TRUE, values path appended file path parsed url.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create SharePoint folders — sp_dir_create","text":"","code":"sp_dir_create( path, ..., drive_name = NULL, drive_id = NULL, drive = NULL, relative = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create SharePoint folders — sp_dir_create","text":"path character vector one paths. ... Arguments passed get_sp_drive drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. relative TRUE drive_name folder URL, values path appended file path parsed url. relative character vector, must length 1 length path appended path vector parent directories. second option takes precedence file path parsed url. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create SharePoint folders — sp_dir_create","text":"","code":"drive_url <- \"\" if (is_sp_url(drive_url)) { sp_dir_create( path = \"parent_folder/subfolder\", drive_name = drive_url ) sp_dir_create( path = c(\"subfolder1\", \"subfolder2\", \"subfolder3\"), relative = \"parent_folder\", drive_name = drive_url ) } dir_url <- \"\" if (is_sp_url(dir_url)) { sp_dir_create( path = c(\"subfolder1\", \"subfolder2\", \"subfolder3\"), drive_name = dir_url, relative = TRUE ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":null,"dir":"Reference","previous_headings":"","what":"List SharePoint files and folders — sp_dir_info","title":"List SharePoint files and folders — sp_dir_info","text":"sp_dir_info() wrapper list_files method additional features based fs::dir_info(). sp_dir_ls() returns character vector yet include support recurse argument. {fs} installed, size column formatted using fs::as_fs_bytes() additional \"type\" factor column added values directory file.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List SharePoint files and folders — sp_dir_info","text":"","code":"sp_dir_info( path = NULL, ..., info = \"partial\", full_names = TRUE, pagesize = 1000, drive_name = NULL, drive_id = NULL, drive = NULL, recurse = FALSE, type = \"any\", regexp = NULL, invert = FALSE, perl = FALSE, call = caller_env() ) sp_dir_ls( path = NULL, ..., full_names = FALSE, pagesize = 1000, drive_name = NULL, drive_id = NULL, drive = NULL, type = \"any\", regexp = NULL, invert = FALSE, perl = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List SharePoint files and folders — sp_dir_info","text":"path Path directory folder. SharePoint folder URLs allowed. NULL, path set default \"/\". ... Arguments passed get_sp_drive drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. info information return: \"partial\", \"name\" \"\". \"partial\", data frame returned containing name, size, ID whether item file folder. \"\", data frame returned containing properties item (can large). full_names TRUE (default), return full file path name item. pagesize Maximum number items return. Defaults 1000. Decrease experiencing timeouts. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. recurse TRUE, get info directory supplied path combine info item info supplied path. type Type item return. Can \"\", \"file\", \"directory\". \"directory\" supported option sp_dir_ls() regexp Regular expression passed grep() used filter paths returned. invert logical. TRUE return indices values elements match. perl logical. Perl-compatible regexps used? call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_dir_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List SharePoint files and folders — sp_dir_info","text":"","code":"dir_url <- \"\" if (is_sp_url(dir_url)) { sp_dir_info( path = dir_url ) sp_dir_ls( path = dir_url ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_drive.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","title":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","text":"get_sp_drive() wraps get_drive method returns ms_drive object. cache_sp_drive() allows cache default SharePoint drive use functions. Additional parameters ... passed get_sp_drive().","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_drive.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","text":"","code":"get_sp_drive( drive_name = NULL, drive_id = NULL, drive_url = NULL, properties = FALSE, ..., site_url = NULL, site = NULL, default_drive_name = getOption(\"sharepointr.default_drive_name\", \"Documents\"), cache = FALSE, refresh = TRUE, overwrite = FALSE, cache_file = getOption(\"sharepointr.cache_file_drive\", \"sp_drive.rds\"), call = caller_env() ) cache_sp_drive( ..., drive = NULL, cache_file = getOption(\"sharepointr.cache_file_drive\", \"sp_drive.rds\"), overwrite = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_drive.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint drive or set a default SharePoint drive — sp_drive","text":"drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. properties TRUE, return drive properties instead ms_drive object. Defaults FALSE. ... Arguments passed get_sp_site site_name,site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. drive ms_drive object. drive supplied, drive_name drive_id ignored.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint list or a list of SharePoint lists — sp_list","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"get_sp_list() wrapper get_list list_items methods. function still development support URL parsing used get_sp_item(). list_sp_lists() returns lists SharePoint site drive list data frame. Note, using filter get_sp_list(), names used expression must prefixed \"fields/\" distinguish item metadata.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"","code":"get_sp_list( list_name = NULL, list_id = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, metadata = FALSE, as_data_frame = FALSE, call = caller_env() ) list_sp_lists( site_url = NULL, filter = NULL, n = Inf, ..., site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, as_data_frame = TRUE, call = caller_env() ) get_sp_list_metadata( list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() ) delete_sp_list( list_name = NULL, list_id = NULL, sp_list = NULL, confirm = TRUE, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"list_name, list_id SharePoint List name ID string. ... Arguments passed get_sp_drive drive_url SharePoint Drive URL parse Drive name information. drive_name URL, used drive_url. default_drive_name Drive name string used input document URL drive name part URL. Defaults getOption(\"sharepointr.default_drive_name\", \"Documents\") cache TRUE, cache drive file using cache_sp_drive(). refresh TRUE, get new drive even existing drive cached local option. FALSE, use cached ms_drive object exists. cache_file File name cached drive cache = TRUE. Defaults option set sharepointr.cache_file_drive (defaults \"sp_drive.rds\"). overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. metadata TRUE, get_sp_list() applies get_column_info method returned SharePoint list returns data frame column metadata list. as_data_frame TRUE, return data frame \"ms_list\" column. get_sp_list() returns 1 row data frame list_sp_lists() returns data frame n rows lists available SharePoint site drive. Defaults FALSE. Ignored metadata = TRUE list metadata always returned data frame. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf. sp_list ms_list object. supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, additional parameters passed ... ignored. confirm TRUE, confirm deletion list proceeding.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a SharePoint list or a list of SharePoint lists — sp_list","text":"data frame as_data_frame = TRUE ms_list object (list ms_list objects) FALSE.","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Get, list, update, and delete SharePoint list items — sp_list_item","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"list_sp_list_items() lists sp_list items. Additional functions completed get_item, create_item, update_item, delete_item methods documented Microsoft365R::ms_list.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"","code":"list_sp_list_items( list_name = NULL, list_id = NULL, sp_list = NULL, ..., filter = NULL, select = NULL, all_metadata = FALSE, as_data_frame = TRUE, pagesize = 5000, site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() ) get_sp_list_item( id, list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() ) create_sp_list_items( data, list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, check_fields = TRUE, sync_fields = FALSE, strict = FALSE, call = caller_env() ) update_sp_list_item( id, list_name = NULL, list_id = NULL, sp_list = NULL, ..., site_url = NULL, site = NULL, drive_name = NULL, drive_id = NULL, drive = NULL, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"list_name, list_id SharePoint List name ID string. sp_list ms_list object. supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, additional parameters passed ... ignored. ... Arguments passed get_sp_list list_name,list_id SharePoint List name ID string. metadata TRUE, get_sp_list() applies get_column_info method returned SharePoint list returns data frame column metadata list. drive_name,drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. select character vector column names include returned data frame list items. NULL, data frame includes columns list. all_metadata TRUE, returned data frame contain extended metadata separate columns, data fields nested data frame named fields. always set FALSE n = NULL as_data_frame = FALSE. as_data_frame TRUE, return data frame \"ms_list\" column. get_sp_list() returns 1 row data frame list_sp_lists() returns data frame n rows lists available SharePoint site drive. Defaults FALSE. Ignored metadata = TRUE list metadata always returned data frame. pagesize Number list items return. Reduce default 5000 experiencing timeouts. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site ms_site object. site supplied, site_url, site_name, site_id ignored. drive_name, drive_id SharePoint Drive name ID passed get_drive method SharePoint site object. drive ms_drive object. drive supplied, drive_name drive_id ignored. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. id Required. SharePoint list item ID typically integer record number starting 1 first record. data Required. data frame import items supplied identified SharePoint list. check_fields TRUE (default), column names input data matched fields list object. FALSE, function error column names matched field supplied SharePoint list. sync_fields TRUE, use sync_fields method sync fields local sp_list object fields SharePoint List source. strict TRUE, column names data must matched field names supplied SharePoint list. FALSE (default), unmatched columns dropped warning.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"Creating new list items create_sp_list_items() handling item creation column names data match fields names supplied list includes options: names data match fields list, function errors lists field names. names data match fields list records created. fields corresponding names data remain blank. names data match fields list, default, columns dropped adding items list. strict = TRUE names data match fields, function errors.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_list_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get, list, update, and delete SharePoint list items — sp_list_item","text":"","code":"sp_list_url <- \"\" if (is_sp_url(sp_list_url)) { create_sp_list_items( data = data.frame( Name = c(\"Jim\", \"Jane\", \"Jayden\") ), list_name = sp_list_url ) }"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint plan or list SharePoint plans — sp_plan","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"get_sp_plan() returns single ms_plan object using get_plan method. list_sp_plans() returns data frame plan properties list ms_plan objects.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"","code":"get_sp_plan( plan_title = NULL, plan_id = NULL, ..., site = NULL, site_url = NULL, as_data_frame = FALSE, call = caller_env() ) list_sp_plans( ..., filter = NULL, n = NULL, site = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"plan_title, plan_id Planner title ID. Exactly one two arguments must supplied. ... Additional arguments passed get_sp_group(). site ms_site object. site supplied, site_url, site_name, site_id ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. as_data_frame TRUE (default list_sp_plans()), return data frame plan title, id, creation date/time, owner ID list column named \"ms_plan\" containing ms_plan objects. FALSE (default get_sp_plan()), return ms_plan object list ms_plan objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a SharePoint plan or list SharePoint plans — sp_plan","text":"get_sp_plan(), ms_plan class object 1 row data frame \"ms_plan\" column. list_sp_plans(), list ms_plan class objects data frame list column named \"ms_plan\".","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":null,"dir":"Reference","previous_headings":"","what":"List SharePoint planner buckets — sp_plan_bucket","title":"List SharePoint planner buckets — sp_plan_bucket","text":"list_sp_plan_buckets() lists buckets specified plan using list_buckets method.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List SharePoint planner buckets — sp_plan_bucket","text":"","code":"list_sp_plan_buckets( plan_title = NULL, plan_id = NULL, ..., filter = NULL, n = NULL, plan = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List SharePoint planner buckets — sp_plan_bucket","text":"plan_title, plan_id Planner title ID. Exactly one two arguments must supplied. ... Additional arguments passed get_sp_group(). filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf. plan ms_plan object. plan supplied, plan_title, plan_id, additional parameters passed ... ignored. as_data_frame TRUE (default list_sp_plan_buckets()), return data frame object properties list column named \"ms_plan_bucket\" containing ms_plan_task objects. FALSE, return ms_plan_bucket object list ms_plan_bucket objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_plan_bucket.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List SharePoint planner buckets — sp_plan_bucket","text":"list_sp_plan_buckets(), list ms_plan_bucket class objects data frame list column named \"ms_plan_task\".","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint site or set a default SharePoint site — sp_site","title":"Get a SharePoint site or set a default SharePoint site — sp_site","text":"get_sp_site() wrapper Microsoft365R::get_sharepoint_site() returns ms_site object. cache_sp_site() allows cache default SharePoint site use functions.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint site or set a default SharePoint site — sp_site","text":"","code":"get_sp_site( site_url = NULL, site_name = NULL, site_id = NULL, ..., cache = FALSE, refresh = TRUE, overwrite = FALSE, cache_file = getOption(\"sharepointr.cache_file_site\", \"sp_site.rds\"), call = caller_env() ) cache_sp_site( ..., site = NULL, cache_file = getOption(\"sharepointr.cache_file_site\", \"sp_site.rds\"), cache_dir = \"sharepointr.cache_dir\", overwrite = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint site or set a default SharePoint site — sp_site","text":"site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. ... Arguments passed Microsoft365R::get_sharepoint_site app custom app registration ID use authentication. See . scopes Microsoft Graph scopes (permissions) obtain. never necessary change . token AAD OAuth token object, class AzureAuth::AzureToken. supplied, tenant, app, scopes ... arguments ignored. See \"Authenticating token\" . tenant get_business_onedrive, get_sharepoint_site get_team, name Azure Active Directory (AAD) tenant. supplied, use value CLIMICROSOFT365_TENANT environment variable, \"common\" unset. cache TRUE, cache site file using cache_sp_site(). refresh TRUE, get new site even existing site cached local option. FALSE, use cached ms_site object. overwrite TRUE, replace existing cached object named cache_file new object. FALSE, error cached file cache_file name already exists. cache_file File name cached file cache = TRUE. Defaults \"sp_site.rds\" option set sharepointr.cache_file_site. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. site ms_site object. site supplied, site_url, site_name, site_id ignored. cache_dir Cache directory. default, uses environmental variable named \"sharepointr.cache_dir\". \"sharepointr.cache_dir\" set, cache directory set rappdirs::user_cache_dir(\"sharepointr\").","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a SharePoint task or list tasks from a planner — sp_tasks","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"get_sp_task() gets individual planner task using get_task method. list_sp_tasks() lists tasks specified plan using list_tasks method.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"","code":"get_sp_task( task_title = NULL, task_id = NULL, ..., plan_title = NULL, plan_id = NULL, plan = NULL, as_data_frame = FALSE, call = caller_env() ) list_sp_tasks( plan_title = NULL, plan_id = NULL, ..., filter = NULL, n = NULL, plan = NULL, as_data_frame = TRUE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"task_title, task_id Planner task title id. Exactly one task_title task_id must supplied. ... Additional arguments passed get_sp_group(). plan_title, plan_id Planner title ID. Exactly one two arguments must supplied. plan ms_plan object. plan supplied, plan_title, plan_id, additional parameters passed ... ignored. as_data_frame TRUE (default list_sp_tasks()), return data frame object properties list column named \"ms_plan_task\" containing ms_plan_task objects. FALSE (default get_sp_task()), return ms_plan_task object list ms_plan_task objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information. filter string OData expression apply filter results. Learn Microsoft Graph API documentation using filter query parameters. n Maximum number lists, plans, tasks, items return. Defaults NULL sets n Inf.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_tasks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a SharePoint task or list tasks from a planner — sp_tasks","text":"list_sp_tasks(), list ms_plan_task class objects data frame list column named \"ms_plan_task\".","code":""},{"path":[]},{"path":"https://elipousson.github.io/sharepointr/reference/sp_url_parse.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","title":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","text":"sp_url_parse() parses URL named list parts. sp_url_parse_hostname() parses hostname tenant base_url. sp_url_parse_path() parses path URL type, permissions, drive name, file path, file name. sp_url_parse_query() parses item ID query.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/sp_url_parse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","text":"","code":"sp_url_parse(url, call = caller_env()) sp_url_parse_hostname(hostname, tenant = \"[a-zA-Z0-9.-]+\", scheme = \"https\") sp_url_parse_path( path, url_type = \"w|x|p|o|b|t|i|v|f|u|li\", permissions = \"r|s|t|u|g\", drive_name_prefix = \"Shared \", default_drive_name = \"Documents\" ) sp_url_parse_query(query)"},{"path":"https://elipousson.github.io/sharepointr/reference/sp_url_parse.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Parse a SharePoint URL using httr2::url_parse — sp_url_parse","text":"Types SharePoint URLs SharePoint site URL: https://[tenant].sharepoint.com/sites/[site name] SharePoint document editor URL: https://[tenant].sharepoint.com/:[url type]:/[permissions]/sites/[site name]/_layouts/15/Doc.aspx?sourcedoc=[item id]&file=[file name]&[additional query parameters] SharePoint List URL: https://[tenant].sharepoint.com/sites/[site name]/Lists/[list name]/AllItems.aspx?env=WebViewList https://[tenant].sharepoint.com/:l:/r/sites/[site name]/Lists/[list name] SharePoint folder URL: https://[tenant].sharepoint.com/:[url type]:/[permissions]/sites/[site name]/[drive name (possible \"Shared\" prefix)]/[folder path]/[folder name]/?[additional query parameters] SharePoint Planner URL: https://tasks.office.com/[tenant].onmicrosoft.com/en-US/Home/Planner/#/plantaskboard?groupId=[Group ID]&planId=[Plan ID]","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/upload_sp_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload a file or folder to a SharePoint Drive — upload_sp_item","title":"Upload a file or folder to a SharePoint Drive — upload_sp_item","text":"upload_sp_item() wraps upload_folder upload_file method ms_drive objects.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/upload_sp_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload a file or folder to a SharePoint Drive — upload_sp_item","text":"","code":"upload_sp_item( file = NULL, dest, ..., src = NULL, overwrite = FALSE, drive_name = NULL, drive_id = NULL, drive = NULL, blocksize = 327680000, recursive = FALSE, parallel = FALSE, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/upload_sp_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload a file or folder to a SharePoint Drive — upload_sp_item","text":"file Path file directory upload. Optional src supplied. dest Destination SharePoint file upload. SharePoint folder URLs supported. ... Additional parameters passed get_sp_site() Microsoft365R::get_sharepoint_site(). src Data source path passed upload_folder upload_file method. Defaults NULL set use file value default. overwrite FALSE (default), error item name specified file src already exists specified destination. TRUE, overwrite existing items name. latter default upload_file method. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. blocksize, recursive, parallel Additional parameters passed upload_folder upload_file method ms_drive objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":null,"dir":"Reference","previous_headings":"","what":"Write an object to file and upload file to SharePoint — write_sharepoint","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"write_sharepoint() uses upload_sp_item() upload object created using: sf::write_sf() x sf object readr::write_csv() x data.frame file include xlsx extension openxlsx2::write_xlsx() x data.frame file include xlsx extension print() method {officer} x rdocx, rpptx, rxlsx object readr::write_rds() x class","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"","code":"write_sharepoint( x, file, dest, ..., .f = NULL, new_path = tempdir(), overwrite = FALSE, drive_name = NULL, drive_id = NULL, drive = NULL, site_url = NULL, site_name = NULL, site_id = NULL, site = NULL, blocksize = 327680000, call = caller_env() )"},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"x Object write file upload SharePoint. sf, rdocx, rpptx, rxlsx, data.frame objects saved functions noted description. object types saved rds outputs. file File write . Passed file parameter readr::write_csv() readr::write_rds(), dsn sf::write_sf(), target print() (working {officer} class objects). dest Destination SharePoint file upload. SharePoint folder URLs supported. ... Additional parameters passed write function. .f Optional function write input data disk uploading file SharePoint. new_path Path write file . Defaults tempdir() overwrite FALSE (default), error item name specified file src already exists specified destination. TRUE, overwrite existing items name. latter default upload_file method. drive_name, drive_id SharePoint drive name ID. drive ms_drive object. drive supplied, drive_name, site_url, additional parameters passed ... ignored. site_url SharePoint site URL format \"https://[tenant name].sharepoint.com/sites/[site name]\". SharePoint item document URL can also parsed build site URL using tenant site name included URL. site_name, site_id Site name ID SharePoint site alternative SharePoint site URL. Exactly one site_url, site_name, site_id must supplied. site ms_site object. site supplied, site_url, site_name, site_id ignored. blocksize Additional parameter passed upload_folder upload_file method ms_drive objects. call execution environment currently running function, e.g. caller_env(). function mentioned error messages source error. See call argument abort() information.","code":""},{"path":"https://elipousson.github.io/sharepointr/reference/write_sharepoint.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write an object to file and upload file to SharePoint — write_sharepoint","text":"Invisibly returns input object x.","code":""}] diff --git a/sitemap.xml b/sitemap.xml index 41d7ff7..bd07d6a 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -51,6 +51,12 @@ https://elipousson.github.io/sharepointr/reference/list_sp_drives.html + + https://elipousson.github.io/sharepointr/reference/list_sp_item_versions.html + + + https://elipousson.github.io/sharepointr/reference/list_sp_pages.html + https://elipousson.github.io/sharepointr/reference/ms_graph_arg_terms.html