diff --git a/.Rbuildignore b/.Rbuildignore index 91114bf..112ad26 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,3 @@ ^.*\.Rproj$ ^\.Rproj\.user$ +^\.travis\.yml$ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..8d139ac --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +# R for travis: see documentation at https://docs.travis-ci.com/user/languages/r + +language: R +sudo: false +cache: packages diff --git a/DESCRIPTION b/DESCRIPTION index 7627aed..efc734a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -20,5 +20,5 @@ Suggests: testthat License: GPL-3 LazyData: true -RoxygenNote: 5.0.1 +RoxygenNote: 6.0.1 VignetteBuilder: knitr diff --git a/README.md b/README.md index 83b1bc3..cb1ec51 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Travis-CI Build Status](https://travis-ci.org/IronistM/gpagespeed.svg?branch=master)](https://travis-ci.org/IronistM/gpagespeed) + # gpagespeed gpagespeed is a package designed to facilitate utilization of the Google PageSpeed Insights API. The PageSpeed Insights API provides insight into how Google's bots evaluate a given page, and the factors that web developers may wish to consider in building pages that will render faster. See Google's documentation on the PageSpeed Insights API to learn more about what the API offers as well as practical examples of its usage. diff --git a/man/speedfinder.Rd b/man/speedfinder.Rd index 3b6a15a..f70d051 100644 --- a/man/speedfinder.Rd +++ b/man/speedfinder.Rd @@ -20,4 +20,3 @@ The speedfinder function returns the Google Page Speed Insights test results for \examples{ speedfinder("https://www.cars.com","mobile",key) } - diff --git a/man/speedfinder2.Rd b/man/speedfinder2.Rd index 3b28d61..3451f44 100644 --- a/man/speedfinder2.Rd +++ b/man/speedfinder2.Rd @@ -10,4 +10,3 @@ speedfinder2(url, strategy, key) Speedfinder2 is a function utilized by speedlist to allow a list of URLs to be submitted to the Google Page Speed Insights API. } - diff --git a/man/speedlist.Rd b/man/speedlist.Rd index 7120c59..2ab1fc2 100644 --- a/man/speedlist.Rd +++ b/man/speedlist.Rd @@ -21,4 +21,3 @@ each row contains the results from the API for a unique URL in the list. \examples{ speedlist(listofURLs,"mobile",key) } - diff --git a/vignettes/my-vignette.Rmd b/vignettes/my-vignette.Rmd deleted file mode 100644 index 5bf91e2..0000000 --- a/vignettes/my-vignette.Rmd +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "Introduction to gpagespeed" -author: "Simit Patel" -date: "`r Sys.Date()`" -output: rmarkdown::html_vignette -vignette: > - %\VignetteIndexEntry{Introduction to gpagespeed} - %\VignetteEngine{knitr::rmarkdown} - %\VignetteEncoding{UTF-8} ---- - -## gpagespeed Introduction - -gpagespeed is a package designed to facilitate utilization of the Google PageSpeed Insights API. The PageSpeed Insights API provides insight into how Google's bots evaluate a given page, and the factors that web developers may wish to consider in building pages that will render faster. See Google's [documentation on the PageSpeed Insights API](https://developers.google.com/speed/docs/insights/about) to learn more about what the API offers as well as practical examples of its usage. - -The PageSpeed Insights API returns a numeric summary of the results of each page, as well as recommendations in text format. Currently, this package is designed to support only retrieving the numeric summary, which includes the overall speed score as well as metrics pertaining to the number of file requests and sizes in kilobytes of images, HTML, CSS, and JavaScript. The package offers two functions: __speedfinder__ and __speedlist__. These functions are documented below. - -## Functions in gpagespeed - -1.__speedfinder.__ The speedfinder function returns a dataframe with a single observation and columsn of numeric data as its response. It accepts three arguments: - - *_url_: The url argument refers to the url of the document on which the PageSpeed Insights API should be run and the corresponding summary metrics returned. - *_strategy_: This argument should have one of two potential text string inputs: "desktop" or "mobile" to denote the device context that the PageSpeed Insights API should use in its evaluation. - *_key_: This is the key that is required to use the API. [Visit Google's Developer Console](https://developers.google.com/console/help/using-keys) to obtain your free key. - - -1.__speedlist.__ The speedlist function is like the speedfinder function, but allows processing of many URLs and returns a dataframe in which each observation corresponds to a unique URL. Like speedfinder, it accepts three arguments: - - *_pagelist_: A list object in which each item in the list is a URL listed as a character string. - *_strategy_: This argument should have one of two potential text string inputs: "desktop" or "mobile" to denote the device context that the PageSpeed Insights API should use in its evaluation. - *_key_: This is the key that is required to use the API. [Visit Google's Developer Console](https://developers.google.com/console/help/using-keys) to obtain your free key. - -## Example Usage - -Below are examples of how the __speedfinder__ and __speedlist__ functions could be called in an R script. - -```{r, results='hide'} -#get speed metrics for a single URL and assign it to a variable - -df1 <- speedfinder("https://www.cars.com","mobile","atextkeyigotfromgoogle111") - -#get speed metrics for a list of URLs and have it all returned in a single dataframe - -df2 <- speedlist(c("https://www.cars.com","http://www.yahoo.com","http://www.techmeme.com"), - "mobile","atextkeyigotfromgoogle111") - -``` -