diff --git a/.Rbuildignore b/.Rbuildignore index b010924..7426940 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,6 @@ CONTRIBUTING.md ^SECURITY\.md$ azure-pipelines.yml ^\.github$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..314763c --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,35 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/master/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master, pkgdown_site] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v2 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Deploy package + run: | + git config --local user.name "$GITHUB_ACTOR" + git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com" + Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)' diff --git a/.gitignore b/.gitignore index fae8299..6fa29c4 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,4 @@ vignettes/*.pdf # R Environment Variables .Renviron +docs diff --git a/DESCRIPTION b/DESCRIPTION index 171e768..8daffa9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -36,4 +36,5 @@ Suggests: emayili, readr Roxygen: list(markdown=TRUE, r6=FALSE) -RoxygenNote: 7.2.1 +RoxygenNote: 7.2.3 +Encoding: UTF-8 diff --git a/Microsoft365R.Rproj b/Microsoft365R.Rproj new file mode 100644 index 0000000..21a4da0 --- /dev/null +++ b/Microsoft365R.Rproj @@ -0,0 +1,17 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX + +BuildType: Package +PackageUseDevtools: Yes +PackageInstallArgs: --no-multiarch --with-keep.source diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..1bdca4e --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,49 @@ +reference: +- title: Login Clients + desc: Login Clients for Microsoft 365 +- contents: + - starts_with('get') + - starts_with('list') +- title: Teams Class Objects + desc: R6 Class Objects for Microsoft Teams +- contents: + - ms_team + - ms_team_member + - ms_channel + - ms_chat + - ms_chat_message +- title: OneDrive and SharePoint Class Objects + desc: R6 class objects for Microsoft OneDrive and SharePoint +- contents: + - ms_site + - ms_drive + - ms_drive_item + - ms_list + - ms_list_item +- title: Outlook Class Objects + desc: R6 class objects for Microsoft Outlook +- contents: + - ms_outlook + - ms_outlook_attachment + - ms_outlook_email + - ms_outlook_folder +- title: Planner Class Objects + desc: R6 class objects for Microsoft Planner +- contents: + - ms_plan + - ms_plan_bucket + - ms_plan_task +- title: Deprecated Functions + desc: Deprecated functions no longer in use +- contents: + - personal_onedrive + - business_onedrive + - sharepoint_site +- title: Accessor Methods + desc: Microsoft 365 object accessor methods +- contents: + - add_methods +- title: Microsoft365r Options + desc: Global options for interaction with the underlying Graph API +- contents: + - microsoft365r_options diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png new file mode 100644 index 0000000..4827e84 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png new file mode 100644 index 0000000..84db61a Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png new file mode 100644 index 0000000..b1909c5 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png new file mode 100644 index 0000000..3f406b7 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png new file mode 100644 index 0000000..fb4834f Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png new file mode 100644 index 0000000..5336c40 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png new file mode 100644 index 0000000..35cdbc2 Binary files /dev/null and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png new file mode 100644 index 0000000..66885c6 Binary files /dev/null and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico new file mode 100644 index 0000000..af14d26 Binary files /dev/null and b/pkgdown/favicon/favicon.ico differ diff --git a/vignettes/auth.Rmd b/vignettes/auth.Rmd index d45a873..31d1562 100644 --- a/vignettes/auth.Rmd +++ b/vignettes/auth.Rmd @@ -3,7 +3,7 @@ title: "Authenticating to Microsoft 365" author: Hong Ooi output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{Authentication} + %\VignetteIndexEntry{Authenticating to Microsoft 365} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{utf8} --- diff --git a/vignettes/scripted.Rmd b/vignettes/scripted.Rmd index 5933331..c4d3fb9 100644 --- a/vignettes/scripted.Rmd +++ b/vignettes/scripted.Rmd @@ -3,7 +3,7 @@ title: "Using Microsoft365R in an unattended script" author: Hong Ooi output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{Microsoft365R in an unattended script} + %\VignetteIndexEntry{Using Microsoft365R in an unattended script} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{utf8} --- diff --git a/vignettes/shiny.Rmd b/vignettes/shiny.Rmd index f6fc644..96ccf4d 100644 --- a/vignettes/shiny.Rmd +++ b/vignettes/shiny.Rmd @@ -3,7 +3,7 @@ title: "Using Microsoft365R in a Shiny app" author: Hong Ooi output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{Microsoft365R and Shiny} + %\VignetteIndexEntry{Using Microsoft365R in a Shiny app} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{utf8} ---