Added pagesize argument to compare_scholars.

jkeirstead · Feb 13, 2015 · cfe069b · cfe069b
1 parent 288a2a5
commit cfe069b
Show file tree

Hide file tree

Showing 14 changed files with 33 additions and 16 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.0.1): do not edit by hand
+# Generated by roxygen2 (4.1.0): do not edit by hand
 
 export(compare_scholar_careers)
 export(compare_scholars)

diff --git a/R/compare.r b/R/compare.r
@@ -8,6 +8,8 @@ utils::globalVariables(c("year", "cites"))
 ##' the scholar's publications by year of publication.
 ##'
 ##' @param ids 	a vector of Google Scholar IDs
+##' @param pagesize an integer specifying the number of articles to
+##' fetch for each scholar
 ##' @return a data frame giving the ID of each scholar and the total
 ##' number of citations received by work published in a year.
 ##' @examples {
@@ -19,10 +21,10 @@ utils::globalVariables(c("year", "cites"))
 ##' }
 ##' @export
 ##' @import plyr
-compare_scholars <- function(ids) {
+compare_scholars <- function(ids, pagesize=100) {
 
   ## Load in the publication data and summarize
-  data <- lapply(ids, function(x) return(cbind(id=x, get_publications(x))))
+  data <- lapply(ids, function(x) return(cbind(id=x, get_publications(x, pagesize=pagesize))))
   data <- ldply(data)
   data <- ddply(data, .(id, year), summarize, cites=sum(cites, na.rm=TRUE))
   data <- ddply(data, .(id), transform, total=cumsum(cites))

diff --git a/man/compare_scholar_careers.Rd b/man/compare_scholar_careers.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/compare.r
 \name{compare_scholar_careers}
 \alias{compare_scholar_careers}
 \title{Compare the careers of multiple scholars}

diff --git a/man/compare_scholars.Rd b/man/compare_scholars.Rd
@@ -1,12 +1,16 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/compare.r
 \name{compare_scholars}
 \alias{compare_scholars}
 \title{Compare the citation records of multiple scholars}
 \usage{
-compare_scholars(ids)
+compare_scholars(ids, pagesize = 100)
 }
 \arguments{
 \item{ids}{a vector of Google Scholar IDs}
+
+\item{pagesize}{an integer specifying the number of articles to
+fetch for each scholar}
 }
 \value{
 a data frame giving the ID of each scholar and the total

diff --git a/man/get_citation_history.Rd b/man/get_citation_history.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/scholar.r
 \name{get_citation_history}
 \alias{get_citation_history}
 \title{Get historical citation data for a scholar}

diff --git a/man/get_num_articles.Rd b/man/get_num_articles.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/publications.r
 \name{get_num_articles}
 \alias{get_num_articles}
 \title{Calculates how many articles a scholar has published}

diff --git a/man/get_num_distinct_journals.Rd b/man/get_num_distinct_journals.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/scholar.r
 \name{get_num_distinct_journals}
 \alias{get_num_distinct_journals}
 \title{Gets the number of distinct journals in which a scholar has

diff --git a/man/get_num_top_journals.Rd b/man/get_num_top_journals.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/scholar.r
 \name{get_num_top_journals}
 \alias{get_num_top_journals}
 \title{Gets the number of top journals in which a scholar has published}

diff --git a/man/get_oldest_article.Rd b/man/get_oldest_article.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/publications.r
 \name{get_oldest_article}
 \alias{get_oldest_article}
 \title{Gets the year of the oldest article for a scholar}

diff --git a/man/get_profile.Rd b/man/get_profile.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/scholar.r
 \name{get_profile}
 \alias{get_profile}
 \title{Gets profile information for a scholar}

diff --git a/man/get_publications.Rd b/man/get_publications.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/publications.r
 \name{get_publications}
 \alias{get_publications}
 \title{Gets the publications for a scholar}

diff --git a/man/predict_h_index.Rd b/man/predict_h_index.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/predict.r
 \name{predict_h_index}
 \alias{predict_h_index}
 \title{Predicts the h-index for a researcher}

diff --git a/man/scholar.Rd b/man/scholar.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/scholar-package.r
 \docType{package}
 \name{scholar}
 \alias{scholar}

diff --git a/man/tidy_id.Rd b/man/tidy_id.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/scholar-package.r
 \name{tidy_id}
 \alias{tidy_id}
 \title{Ensures that specified IDs are correctly formatted}