Package 'orderly.sharepoint'

Title: Sharepoint Driver for Orderly
Description: Store orderly reports on Sharepoint. Provides an orderly remote driver that can be used to share orderly reports using Sharepoint. You can use Sharepoint's access controls and use this to set up a lightweight way of using orderly within a team.
Authors: Rich FitzJohn [aut, cre], Imperial College of Science, Technology and Medicine [cph]
Maintainer: Rich FitzJohn <[email protected]>
License: MIT + file LICENSE
Version: 0.1.5
Built: 2024-12-11 03:10:21 UTC
Source: https://github.com/vimc/orderly.sharepoint

Help Index


Create an orderly remote based on Sharepoint

Description

Implements an orderly "remote" using Sharepoint as a backend. Use this within an orderly_config.yml configuration.

Usage

orderly_remote_sharepoint(url, site, path, name = NULL)

Arguments

url

Sharepoint URL

site

Sharepoint "site"

path

Path within the Sharepoint site. In our experience these often start with Shared Documents but your setup may vary.

name

Friendly name for the remote

Details

A configuration might look like:

remote:
  real:
    driver: orderly.sharepoint::orderly_remote_sharepoint
    args:
      url: https://example.sharepoint.com
      site: mysite
      path: Shared Documents/orderly/real

which would create a remote called real, using your group's Sharepoint hosted at https://example.sharepoint.com, on site mysite and within that site using path Shared Documents/orderly/real.

Currently authentication is interactive, or uses the values of environment variables SHAREPOINT_USERNAME and SHAREPOINT_PASS. Once we expose richer authentication approaches in spud that will be exposed here (RESIDE-162).

This function is not intended to be used interactively

Value

An orderly_remote_sharepoint object

An orderly_remote_sharepoint object, designed to be used by orderly. This function should however not generally be called by users directly, as it should be used within orderly_config.yml