release 0.1.4 (#48)

* swap in new videos in vignettes

* bump version

* update links in README

* update code of conduct

* update README, cran comments

* update cran comments

* clean up docs

* update cran comments

Author: ijlyttle

.Rbuildignore

@@ -2,7 +2,6 @@
 ^\.Rproj\.user$
 ^README\.Rmd$
 ^README-.*\.png$
-^CONDUCT\.md$
 ^\.travis\.yml$
 ^cran-comments\.md$
 ^codecov\.yml$
@@ -11,3 +10,4 @@
 ^docs$
 ^\.github$
 ^checklist-new-service\.md$
+^CODE_OF_CONDUCT\.md$

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards
+of acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies
+when an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [INSERT CONTACT
+METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/
+code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://
+www.contributor-covenant.org/translations.

CONDUCT.md

@@ -1,6 +1,6 @@
 Package: vembedr
 Title: Embed Video in HTML
-Version: 0.1.3.9003
+Version: 0.1.4
 Authors@R: c(
     person(
       given = "Ian", 

DESCRIPTION

@@ -1,6 +1,6 @@
-## vembedr 0.1.3.9000
+## vembedr 0.1.4
 
-- add support for [Microsoft Stream](https://www.microsoft.com/en-us/microsoft-365/microsoft-stream), which offers an enterprise video service; this will likely be for use internal to an organization. (#38)
+- adds support for [Microsoft Stream](https://www.microsoft.com/en-us/microsoft-365/microsoft-stream), which offers an enterprise video service; this will likely be for use internal to an organization. (#38)
 - if you have a recent version of [usethis](https://usethis.r-lib.org) installed, `suggest_embed()` will copy the suggested code to your clipboard. (#32)
 - sets the default `height` to 300 pixels, and introduces an argument `ratio`, to set the aspect ratio; legal values are `"16by9"` or `"4by3"`. If you set the `width` and `height`, `ratio` is ignored. If you specify only one of `width` or `height`, `ratio` is used to calculate the other. (#33)
 - adds three functions to help with formatting; they are all pipeable with `embed_*()` functions:

NEWS.md

@@ -1,8 +1,8 @@
 #' vembedr S3 Classes
 #'
 #' Knowledge of these classes is not needed for day-to-day use. Rather,
-#' it is a bookkeeping device used to make it clearer to add a new service
-#' in development.
+#' it is a bookkeeping device used to make it clearer to a developer
+#' how to add a new service.
 #'
 #' We use S3 classes to distinguish an embed object, and to denote which
 #' service it uses. Objects of these classes are created by [embed_url()]
@@ -16,22 +16,22 @@
 #'
 #' There is an additional class attached according to the service:
 #'
-#' **`vembedr_embed_youtube`**
-#' **`vembedr_embed_youtube_short`**
-#' **`vembedr_embed_vimeo`**
-#' **`vembedr_embed_channel9`**
-#' **`vembedr_embed_box`**
-#' **`vembedr_embed_msstream`**
+#' - **`vembedr_embed_youtube`**
+#' - **`vembedr_embed_youtube_short`**
+#' - **`vembedr_embed_vimeo`**
+#' - **`vembedr_embed_channel9`**
+#' - **`vembedr_embed_box`**
+#' - **`vembedr_embed_msstream`**
 #'
 #' To support parsing, there is an internal S3 class attached to the URL
 #' being processed. It is named according to the service:
 #'
-#' **`vembedr_url_youtube`**
-#' **`vembedr_url_youtube_short`**
-#' **`vembedr_url_vimeo`**
-#' **`vembedr_url_channel9`**
-#' **`vembedr_url_box`**
-#' **`vembedr_url_msstream`**
+#'  - **`vembedr_url_youtube`**
+#'  - **`vembedr_url_youtube_short`**
+#'  - **`vembedr_url_vimeo`**
+#'  - **`vembedr_url_channel9`**
+#'  - **`vembedr_url_box`**
+#'  - **`vembedr_url_msstream`**
 #'
 #' @name vembedr-s3-classes
 #'

R/s3-classes.R

@@ -23,14 +23,16 @@ knitr::opts_chunk$set(
 )
 ```
 
-The goal of the vembedr package is to make it a little bit easier for you to embed videos into your **rmarkdown** documents and your **shiny** apps. Four services are currently supported:
+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.3.9000
+## New to version 0.1.4
 
 - new functions to help you format: `use_rounded()`, `use_align()`, and `use_bs_responsive()`.
 - new services supported:
@@ -56,36 +58,42 @@ devtools::install_github("ijlyttle/vembedr")
 
 This project supports two documentation-websites, built using [pkgdown](https://pkgdown.r-lib.org):
 
-- [CRAN version](https://ijlyttle.github.io/vembedr)
-- latest [developent version](https://ijlyttle.github.io/vembedr/dev) from GitHub
+- [CRAN version](https://ijlyttle.github.io/vembedr/)
+- latest [developent version](https://ijlyttle.github.io/vembedr/dev/) from GitHub
 
 ### 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:
+The most useful function might be `embed_url()`. 
+If the URL is from one of the supported services, it will do the right thing:
 
 ```r
 library("vembedr")
 
 embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs")
 ```
 
-To see this in action, please see `vignette("vembedr")`. 
+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")`. 
 
-To see details on each of the services supported, see `vignette("embed")`. You can also modify the appearance and the start time, for example:
+The functions are designed to be piped. 
+For example, here's how you can modify the appearance and the start time:
 
 ```r
 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 not all videos will play when embedded at a different site (like your RMarkdown document). This is due to licensing issues. 
+ - 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. Everthing should work well in a browser like Chrome.
+ - 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 this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
+Please note that the vembedr project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

README.Rmd

@@ -8,16 +8,17 @@ status](https://github.com/ijlyttle/vembedr/workflows/R-CMD-check/badge.svg)](ht
 [![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
 <!-- badges: end -->
 
-The goal of the vembedr package is to make it a little bit easier for
-you to embed videos into your **rmarkdown** documents and your **shiny**
-apps. Four services are currently supported:
+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.3.9000
+## New to version 0.1.4
 
   - new functions to help you format: `use_rounded()`, `use_align()`,
     and `use_bs_responsive()`.
@@ -45,8 +46,8 @@ devtools::install_github("ijlyttle/vembedr")
 This project supports two documentation-websites, built using
 [pkgdown](https://pkgdown.r-lib.org):
 
-  - [CRAN version](https://ijlyttle.github.io/vembedr)
-  - latest [developent version](https://ijlyttle.github.io/vembedr/dev)
+  - [CRAN version](https://ijlyttle.github.io/vembedr/)
+  - latest [developent version](https://ijlyttle.github.io/vembedr/dev/)
     from GitHub
 
 ### Usage
@@ -60,11 +61,13 @@ library("vembedr")
 embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs")
 ```
 
-To see this in action, please see `vignette("vembedr")`.
+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")`.
 
-To see details on each of the services supported, see
-`vignette("embed")`. You can also modify the appearance and the start
-time, for example:
+The functions are designed to be piped. For example, here’s how you can
+modify the appearance and the start time:
 
 ``` r
 embed_url("https://www.youtube.com/watch?v=uV4UpCq2azs") %>%
@@ -76,14 +79,19 @@ To see these functions in action, see `vignette("modify")`.
 
 ### Caveats
 
-Be aware that not all videos will play when embedded at a different site
-(like your RMarkdown document). This is due to licensing issues.
+  - 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.
-Everthing should work well in a browser like Chrome.
+  - 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 this project is released with a [Contributor Code of
-Conduct](CONDUCT.md). By participating in this project you agree to
-abide by its terms.
+Please note that the vembedr project is released with a [Contributor
+Code of
+Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
+By contributing to this project, you agree to abide by its terms.

README.md

@@ -27,14 +27,9 @@ Methods based on service:
 
 ## Other videos
 
-```r
-embed_youtube("3pKpfs5EK_s") 
-```
 
 ```r
-embed_youtube("KvX8MijgeW8")
+# Otis Redding: Shake
+embed_youtube("3pKpfs5EK_s") 
 ```
 
-```r
-embed_youtube("uKQ01MvF8mY")
-```