Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added man pages for altmetrics

  • Loading branch information...
commit ebfb4eb2c04f1de3cdf390d4f90ee3d96bce0d89 1 parent 1b25441
@sckott sckott authored
View
9 DESCRIPTION
@@ -22,3 +22,12 @@ Suggests:
RCurl,
RJSONIO,
mgcv
+Collate:
+ 'Rollcorr.R'
+ 'altmetrics.R'
+ 'gitstats.R'
+ 'install.verbose.R'
+ 'liveplot.R'
+ 'makefunction.R'
+ 'nabel.R'
+ 'testplothandlers.R'
View
6 NAMESPACE
@@ -1,6 +1,10 @@
+export(Rollcorr)
+export(altmetrics)
+export(digg_user)
export(gitstats)
export(liveplot)
export(makefunction)
export(nabel)
-export(Rollcorr)
export(testplothandlers)
+import(RCurl)
+import(RJSONIO)
View
22 man/altmetrics.Rd
@@ -0,0 +1,22 @@
+\name{altmetrics}
+\alias{altmetrics}
+\title{Plot altmetrics}
+\usage{
+ altmetrics(diggname = "cboettig", gitid = "cboettig",
+ gittype = "user")
+}
+\arguments{
+ \item{diggname}{Digg username}
+
+ \item{gitid}{GitHub username}
+
+ \item{gittype}{GitHub type, 'user' or 'org'}
+}
+\description{
+ This function plots metrics on persons or articles from
+ many sources.
+}
+\author{
+ Scott Chamberlain
+}
+
View
42 man/digg_user.Rd
@@ -0,0 +1,42 @@
+\name{digg_user}
+\alias{digg_user}
+\title{Get Digg metrics on a user.}
+\usage{
+ digg_user(usernames = NA, userids = NA,
+ url = "http://services.digg.com/2.0/user.getInfo", ...,
+ curl = getCurlHandle())
+}
+\arguments{
+ \item{usernames}{Comma separated list of usernames (e.g.,
+ 'kevinrose,leolaporte').}
+
+ \item{userids}{Comma separated list of user IDs (e.g.,
+ '59,60').}
+
+ \item{url}{The base Digg url (leave to default).}
+
+ \item{...}{optional additional curl options (debugging
+ tools mostly)}
+
+ \item{curl}{If using in a loop, call getCurlHandle()
+ first and pass the returned value in here (avoids
+ unnecessary footprint)}
+}
+\value{
+ A data.frame with results.
+}
+\description{
+ Given a single or multiple Digg usernames or user ID's,
+ returns for each number of diggs, comments, followers,
+ following, and submissions.
+}
+\details{
+ Only supply one or the other of usernames or userids.
+}
+\examples{
+\dontrun{
+digg_user(usernames = 'kevinrose,leolaporte')
+digg_user(userids = '59,60')
+}
+}
+
View
12 man/gitstats.Rd
@@ -3,18 +3,30 @@
\title{Plot github stats}
\usage{
gitstats(id = "hadley", type = "user")
+
+ gitstats(id = "hadley", type = "user")
}
\arguments{
\item{id}{name of the github user or organization}
\item{type}{either "user" or "org"}
+
+ \item{id}{name of the github user or organization}
+
+ \item{type}{either "user" or "org"}
}
\description{
This function plots the total number of forks and
followers for all repositories of a certain user or
organization.
+
+ This function plots the total number of forks and
+ followers for all repositories of a certain user or
+ organization.
}
\author{
Scott Chamberlain
+
+ Scott Chamberlain
}

0 comments on commit ebfb4eb

Please sign in to comment.
Something went wrong with that request. Please try again.