include_tweet: Include A Tweet in All R Markdown Formats

In gadenbuie/tweetrmd: Embed Tweets in R Markdown

Include A Tweet in All R Markdown Formats

Description

Similar to knitr::include_graphics(), but for tweets. In HTML documents, the tweet is embedded using tweet_embed() and for all other documents types a screen shot of the tweet is rendered and used tweet_screenshot(). If you would rather that just the text of the tweet be included in non-HTML outputs, use tweet_embed().

Usage

include_tweet(tweet_url, plain = FALSE, ...)

tweet_markdown(tweet_url, ...)

Arguments

tweet_url	The URL for the tweet, or use tweet_url() to build the URL from a screen_name and status_id.
plain	Embeds the tweet without including Twitter's JavaScript code. This means the tweets will be displayed as minimally styled HTML in tweet_embed() or tweet_screenshot(). In include_tweet(), plain = TRUE will convert the tweet text into markdown for non-HTML outputs. Note that for HTML outputs, you can't selectively choose whether or not a tweet is rendered in plain HTML if you include multiple tweet. Including one rich embedded tweet will trigger rich embedding of all tweets loaded on the page.
...	Arguments passed on to tweet_embed maxwidth The maximum width of a rendered Tweet in whole pixels. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed maxheight parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and 'hide_media“ parameters below. hide_media When set to true, "t", or 1 links in a Tweet are not expanded to photo, video, or link previews. hide_thread When set to true, "t", or 1 a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet. omit_script When set to FALSE, Twitter's remote script responsible for loading the Tweet widget will be used. Otherwise, the script included by this package will be used. If you are including multiple tweets on a page, it is recommended to use the default FALSE. align Specifies whether the embedded Tweet should be floated left, right, or center in the page relative to the parent element. related A comma-separated list of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, like, or retweet the embedded Tweet. lang Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets. theme When set to dark, the Tweet is displayed with light text over a dark background. link_color Adjust the color of Tweet text links with a hexadecimal color value. widget_type Set to video to return a Twitter Video embed for the given Tweet. dnt When set to true, the Tweet and its embedded page on your site are not used for purposes that include personalized suggestions and personalized ads.

Value

An htmltools::tagList() to include a tweet in an HTML document, or a screen shot of the tweet for use in non-HTML outputs.

Functions

• tweet_markdown: Return a tweet as plain markdown.

See Also

Other Tweet-embedding functions: tweet_embed(), tweet_screenshot()

Examples

include_tweet("https://twitter.com/dsquintana/status/1275705042385940480")

gadenbuie/tweetrmd documentation built on Feb. 3, 2023, 1:35 p.m.