File: tweet_shot.Rd

package info (click to toggle)
r-cran-rtweet 2.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,068 kB
  • sloc: sh: 13; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 1,712 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tweet_shot.R
\name{tweet_shot}
\alias{tweet_shot}
\title{Capture an image of a tweet/thread}
\usage{
tweet_shot(statusid_or_url, zoom = 3, scale = TRUE)
}
\arguments{
\item{statusid_or_url}{a valid Twitter status id (e.g. "\code{947082036019388416}") or
a valid Twitter status URL (e.g. "\verb{https://twitter.com/jhollist/status/947082036019388416}").}

\item{zoom}{a positive number >= 1. See the help for \verb{[webshot::webshot()]} for more information.}

\item{scale}{auto-scale the image back to 1:1? Default it \code{TRUE}, which means \code{magick}
will be used to return a "normal" sized tweet. Set it to \code{FALSE} to perform your
own image manipulation.}
}
\value{
\code{magick} object
}
\description{
Provide a status id or a full Twitter link to a tweet and this function
will capture an image of the tweet --- or tweet + thread (if there are
Twitter-linked replies) --- from the mobile version of said tweet/thread.
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
}
\details{
For this to work, you will need to ensure the packages in \verb{Suggests:} are
installed as they will be loaded upon the first invocation of this function.

Use the \code{zoom} factor to get more pixels which may improve the text rendering
of the tweet/thread.
}
\examples{
\dontrun{
if (auth_has_default()) {
    shot1 <- tweet_shot("947061504892919808")
    plot(shot1)
    shot2 <- tweet_shot("https://twitter.com/ma_salmon/status/947061504892919808")
    plot(shot2)
}
}
}
\seealso{
\code{\link{rtweet-deprecated}}
}