Create SharePoint list lookup column and update lookup column items — create_sp_list_lookup

create_sp_list_lookup_column() is a wrapper for create_lookup_column() and create_sp_list_column() that allows for the creation of a column in one list (the "lookup" list) and then create a lookup column in a second list.

Usage

create_sp_list_lookup_column(
  column_name,
  sp_list = NULL,
  lookup_list = NULL,
  lookup_list_column = column_name,
  sp_lookup_list = NULL,
  list_name = NULL,
  site = NULL,
  site_url = NULL,
  ...
)

update_sp_list_lookup_items(
  sp_list = NULL,
  data = NULL,
  column_name,
  lookup_list_data = NULL,
  lookup_list = NULL,
  join_column = column_name,
  ...,
  .id = "id",
  na_fields = c("drop", "replace"),
  .progress = TRUE,
  call = caller_env()
)

Arguments

sp_list

A ms_list object. If supplied, list_name, site, and site_url are all ignored.

lookup_list_column

Name of lookup column in the lookup list to use.

list_name

List name. Required if sp_list is NULL.

site

A ms_site object. If site is supplied, site_url, site_name, and site_id are ignored.

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.

...

Arguments passed on to create_lookup_column

display_as: Value displayed as option. For create_choice_column one ofc("checkBoxes", "dropDownMenu", "radioButtons"). For create_number_column, one of c("number", "percentage"). For create_datetime_column, one of c("default", "friendly", "standard").
.col_type: Column type. Defaults to "text". Must be one of "boolean", "calculated", "choice", "currency", "dateTime", "lookup", "number", "personOrGroup", "text", "term", "hyperlinkOrPicture", "thumbnail", "contentApprovalStatus", or "geolocation".
enforce_unique: Enforce unique values in column.
hidden: If TRUE, column will be hidden by default.
deletable: If TRUE, column can't be deleted separate from the list.
required: If TRUE, column will be required.
default: Default value set by helper get_column_default() function.
description: Column description.
displayname: Column display name.
indexed,sealed,propagate_changes,read_only,validation,id,show_full_name: Additional arguments used by create_column_definition().
multiple_lines: Logical. If TRUE, allow multiple lines of text.
append_changes: Logical. If TRUE, append changes to existing value for column.
lines: Whole number.
max_length: Whole number. Max length in number of characters.
text_type: One of c("plain", "richText")
choices: A character vector of choice options.
allow_na: If TRUE, allow NA values in choices.
na_replacement: Used as replacement by stringr::str_replace_na() on choices if they contain NA values.
allow_text: If TRUE, allow text entry in the choice column.
decimals: One of c("none", "one", "two", "three", "four", "five") or a numeric value between 0 and 5.
max,min: Minimum and maximum values allowed in number column.
locale: Locale
formula: Required string with formula for calculated column definition. See examples of common formulas in lists. Reference existing columns using the display name enclosed in square brackets. The formula must start with an equals sign "=" which this function appends to the formula text if it is missing.
format: "dateOnly" or "dateTime". Required by create_calculated_column if output_type is "dateTime" otherwise ignored.
output_type: Value type returned by calculated formula. One of c("text", "boolean", "currency", "dateTime", "number")
allow_multiple: If TRUE, allow lookup column to return multiple values.
allow_unlimited_length: If TRUE, allow lookup column to return any length value.
primary_lookup_column_id: If column definition is for a secondary column, the primary lookup column ID must be supplied.
from_type: What type of resources to choose from. Defaults to "peopleOnly" for create_person_column() or "peopleAndGroups" for create_group_column()
is_picture: Logical indicator for display of hyperlink value as link (FALSE, default for create_hyperlink_column()) or image (TRUE, default for create_picture_column()).
split: character vector (or object which can be coerced to such) containing regular expression(s) (unless fixed = TRUE) to use for splitting. If empty matches occur, in particular if split has length 0, x is split into single characters. If split has length greater than 1, it is re-cycled along x.