Permalink
Browse files

roxygen fixes

  • Loading branch information...
1 parent 2649f2d commit 87538c46860cd1f1415017e1fc0835cdade90954 @sckott sckott committed Oct 4, 2012
Showing with 112 additions and 7 deletions.
  1. +6 −6 DESCRIPTION
  2. +4 −0 NAMESPACE
  3. +1 −1 R/rGtrends.R
  4. +20 −0 man/add_char.Rd
  5. +21 −0 man/format_py_date.Rd
  6. +40 −0 man/rGtrends.Rd
  7. +20 −0 man/strip_char.Rd
View
@@ -11,13 +11,13 @@ License: CC0
URL: http://github.com/emhart/rGtrends
Bug reports: http://github.com/emhart/rGtrends/issues
Depends:
- rjava
-rjython
-stringr
+ rJava,
+ rJython,
+ stringr
Imports:
- rjava
-rjython
-rstringr
+ rJava,
+ rJython,
+ stringr
Collate:
'add_char.R'
'format_py_date.R'
View
@@ -0,0 +1,4 @@
+export(rGtrends)
+import(rJava)
+import(rJython)
+import(stringr)
View
@@ -8,7 +8,7 @@
#' @import rJython rJava stringr
#' @author Edmund Hart \email{edmund.m.hart@@gmail.com}
#' @export
-#' @example \dontrun{
+#' @examples \dontrun{
#' my_search <- rGrends("Bieber")
#' plot(my_search[,2],my_search[,1],type='l')
#' }
View
@@ -0,0 +1,20 @@
+\name{add_char}
+\alias{add_char}
+\title{Adds quote padding so terms can be searchable with python}
+\usage{
+ add_char(my_string)
+}
+\arguments{
+ \item{my_string}{A vector of strings that are padded with
+ quotation marks so they can be passed to python Required}
+}
+\value{
+ a vector of strings padded with quotes
+}
+\description{
+ Adds quote padding so terms can be searchable with python
+}
+\author{
+ Edmund Hart \email{edmund.m.hart@gmail.com}
+}
+
View
@@ -0,0 +1,21 @@
+\name{format_py_date}
+\alias{format_py_date}
+\title{Formats rJava strings of dates into text that can be converted to POSIX date}
+\usage{
+ format_py_date(date_vec)
+}
+\arguments{
+ \item{date_vec}{A vector of dates retured and stripped of
+ characters from rJava}
+}
+\value{
+ a vector of POSIX formatted dates
+}
+\description{
+ Formats rJava strings of dates into text that can be
+ converted to POSIX date
+}
+\author{
+ Edmund Hart \email{edmund.m.hart@gmail.com}
+}
+
View
@@ -0,0 +1,40 @@
+\name{rGtrends}
+\alias{rGtrends}
+\title{Search google trends (http://trends.google.com)
+using a python API.}
+\usage{
+ rGtrends(keywords,
+ src_path = paste(getwd(), "/src", sep = ""),
+ date = c("all", "all"))
+}
+\arguments{
+ \item{keywords}{A vector of search strings, each term
+ will be a seperate search. Required}
+
+ \item{date}{A vector of dates coded a string in the form
+ YYYY-MM, with the first element being the starting date
+ and the second element the end date. If you want to
+ return the entire range leave blank. If you want from a
+ starting date to the last available point, leave the
+ second element in vector as "all", or the first as "all"
+ to search from the beginning until the specified end
+ date}
+}
+\value{
+ a data frame with weekly search output and search volmue
+ within the specified date range
+}
+\description{
+ Search google trends (http://trends.google.com) using a
+ python API.
+}
+\examples{
+\dontrun{
+my_search <- rGrends("Bieber")
+plot(my_search[,2],my_search[,1],type='l')
+}
+}
+\author{
+ Edmund Hart \email{edmund.m.hart@gmail.com}
+}
+
View
@@ -0,0 +1,20 @@
+\name{strip_char}
+\alias{strip_char}
+\title{Strips rJava S4 class characters from text vector returned from python}
+\usage{
+ strip_char(Js4text)
+}
+\arguments{
+ \item{Js4text}{vector of rJava S4 class strings}
+}
+\value{
+ a vector stripped of quotes ond brackets
+}
+\description{
+ Strips rJava S4 class characters from text vector
+ returned from python
+}
+\author{
+ Edmund Hart \email{edmund.m.hart@gmail.com}
+}
+

0 comments on commit 87538c4

Please sign in to comment.