Git Product home page Git Product logo

vembedr's Introduction

vembedr

CRAN_Status_Badge R-CMD-check

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

  • updated internal implementation to comport with latest Pandoc. (#52, thanks @jnolis!)
  • deprecated Microsoft Channel 9 (including UserR! 2016 & 2017), as Channel 9 has been moved. (#54)

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.