Learn R Programming

vembedr

The goal of vembedr is to make it a little bit easier for you to embed videos into your RMarkdown documents and your Shiny apps; these services are supported:

  • YouTube
  • Vimeo
  • Box
  • Microsoft Stream

New to version 0.1.5

Installation

You can install the latest released version from CRAN with:

install.packages("vembedr")

or the latest development version from GitHub with:

# install.packages("devtools")
devtools::install_github("ijlyttle/vembedr")

Documentation

This project supports two documentation-websites, built using pkgdown:

Usage

The most useful function might be embed_url(). If the URL is from one of the supported services, it will do the right thing:

library("vembedr")

embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs")

The video is not embedded in this README file as is rendered to Markdown; to see embedded videos, please see vignette("vembedr"). Each of the supported services, e.g. YouTube, is discussed in vignette("embed").

The functions are designed to be piped. For example, here’s how you can modify the appearance and the start time:

embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs") %>%
  use_start_time("1m32") %>%
  use_align("center")

To see these functions in action, see vignette("modify").

Caveats

  • Be aware that, due to licensing issues, not all videos will play when embedded at a different site (like your HTML document).

  • The RStudio viewer will embed YouTube and Vimeo videos, but not others. Videos from all services should be rendered as you expect in a browser like Chrome.

  • Some of the formatting, e.g. rounded corners, does not render on mobile sites.

Code of Conduct

Please note that the vembedr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Copy Link

Version

Install

install.packages('vembedr')

Monthly Downloads

1,749

Version

0.1.5

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Ian Lyttle

Last Published

December 11th, 2021

Functions in vembedr (0.1.5)

use_start_time.vembedr_embed_box

Specify start time
use_rounded

Make rounded corners
use_bs_responsive

Make size responsive
vembedr-s3-classes

vembedr S3 Classes
iframe

Accessor methods for iframe
vembedr-package

vembedr: Package for embedding video
use_align

Align horizontally
suggest_embed

Suggest embed-code based on URL
embed_user2016

Embed video from Microsoft Channel 9
%>%

Pipe functions
embed

Embed video from service
parse_video_url

Parse a URL to determine service and id
rickroll

Embed popular video
secs

Get number of seconds given a string
get_service

Determine service based on URL
embed_url

Embed video based on URL
hms

Create an hours-minutes-seconds string