insight_create_request: Create insight object for new insights

Description Usage Arguments Value See Also Examples

View source: R/insight_request.R

Description

Create insight object for new insights

Usage

1
2
3
4
5
6
7
8
9
insight_create_request(
  title,
  description = NULL,
  image_url = NULL,
  embed_url = NULL,
  markdown_body = NULL,
  source_link = NULL,
  data_source_links = NULL
)

Arguments

title

Insight title

description

Optional insight description

image_url

URL of image representing the insight

embed_url

URL of content to embed

markdown_body

Markdown text containing the insight

source_link

Permalink to source code or platform this insight was generated with

data_source_links

List containing one or more permalinks to the data sources used to generate this insight

Value

Request object of type insight_create_request.

See Also

create_insight

Examples

1
2
3
4
request <- dwapi::insight_create_request(title='A title',
  description = 'A description',
  image_url = 'https://site.org/image.png',
  source_link = 'https://site.org/data')

datadotworld/dwapi-r documentation built on July 3, 2021, 3:40 a.m.