1\name{getCurRateLimitInfo}
2\alias{getCurRateLimitInfo}
3\alias{resource_families}
4\title{
5  A function to retrieve current rate limit information
6}
7\description{
8  Will retrieve the current rate limit information for the authenticated user,
9  displayed as a data.frame displaying specifc information for every Twitter resource
10}
11\usage{
12getCurRateLimitInfo(resources=resource_families, ...)
13}
14\arguments{
15  \item{resources}{A character vector of specific resources to get information for}
16  \item{\dots}{Optional arguments to pass to cURL}
17}
18\details{
19  By default, all known resource families will be polled. These families are contained
20  in the object \code{resource_families}. If you would like to filter this down you
21  may tweak the \code{resources} argument.
22
23  The full list of allowed values in \code{resources} is as follows: \code{lists},
24  \code{application}, \code{friendships}, \code{blocks}, \code{geo}, \code{users},
25  \code{followers}, \code{statuses}, \code{help}, \code{friends}, \code{direct_messages},
26  \code{account}, \code{favorites}, \code{saved_searches}, \code{search}, \code{trends}.
27}
28\value{
29  A four column data.frame with columns \code{resource}, \code{limit}, \code{remaining}
30  and \code{reset}. These detail the specific resource name, the rate limit for that block,
31  the number of calls remaining and the time the rate limit will be reset in UTC time.
32}
33\author{
34Jeff Gentry
35}
36\examples{
37  \dontrun{
38    zz <- getCurRateLimitInfo(c("lists", "users"))
39  }
40}
41\keyword{ interface }
42