README.md

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:

New to version 0.1.4

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

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.



Try the vembedr package in your browser

Any scripts or data that you put into this service are public.

vembedr documentation built on Oct. 23, 2020, 8:26 p.m.