vembedr v0.1.4

0

Monthly downloads

0th

Percentile

Embed Video in HTML

A set of functions for generating HTML to embed hosted video in your R Markdown documents or Shiny applications.

Readme

vembedr

CRAN\_Status\_Badge R build
status lifecycle

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. In this verison, five services are supported:

  • YouTube
  • Vimeo
  • Microsoft Channel 9 (including UseR! 2016 and 2017 videos).
  • Box
  • Microsoft Stream

New to version 0.1.4

  • new functions to help you format: use_rounded(), use_align(), and use_bs_responsive().
  • new services supported:
    • Box, using embed_box()
    • Microsoft Stream, using embed_msstream()

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.

Functions in vembedr

Name Description
iframe Accessor methods for iframe
rickroll Embed popular video
embed Embed video from service
get_service Determine service based on URL
secs Get number of seconds given a string
%>% Pipe functions
suggest_embed Suggest embed-code based on URL
hms Create an hours-minutes-seconds string
use_rounded Make rounded corners
parse_video_url Parse a URL to determine service and id
embed_url Embed video based on URL
use_start_time.vembedr_embed_box Specify start time
use_bs_responsive Make size responsive
use_align Align horizontally
vembedr-s3-classes vembedr S3 Classes
vembedr-package vembedr: Package for embedding video
No Results!

Vignettes of vembedr

Name
figures/box-binford.png
embed.Rmd
modify.Rmd
vembedr.Rmd
No Results!

Last month downloads

Details

License MIT + file LICENSE
Encoding UTF-8
LazyData true
RoxygenNote 7.1.1
URL https://github.com/ijlyttle/vembedr
BugReports https://github.com/ijlyttle/vembedr/issues
VignetteBuilder knitr
NeedsCompilation no
Packaged 2020-10-10 13:38:23 UTC; sesa19001
Repository CRAN
Date/Publication 2020-10-10 21:20:02 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/vembedr)](http://www.rdocumentation.org/packages/vembedr)