Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated documentation, tested checks. Waiting on an API issue with me…

…trics otherwise package is near completion. Still need to add in collection_creation and some visualization.
  • Loading branch information...
commit 5c8daf47c23cde21e1fe32c217496fe99c247d4c 1 parent 0ebb2fd
@karthik karthik authored
View
1  DESCRIPTION
@@ -25,6 +25,7 @@ Imports:
plyr
Collate:
'getMetrics.R'
+ 'collection.R'
'api_info.R'
'tiID.R'
'ti_providers.R'
View
2  NAMESPACE
@@ -1,5 +1,7 @@
export(IS_providers)
export(ISid)
export(about_IS)
+export(collection_metrics)
export(create_ISid)
export(metrics)
+export(save_collection)
View
6 R/collection.R
@@ -1,8 +1,8 @@
#' Retrives metadata on a valid Impact Story collecISon ID
#'
-#' @return a \code{list} with the following fields: \item{_id}{id #} \item{_rev}{revision #} \item{created}{created on} \item{ip_address}{ip address of creaISon} \item{items}{list of items} \item{key_hash}{} \item{last_modified}{} \item{owner}{} \item{IStle}{} \item{type}{}.
-#' @param collecISon_id A Impact Story collecISon id
-#' @param as.csv Default is \code{FALSE}. Set to \code{TRUE} to return a .csv file. Use in conjuncISon with \code{\link{save_collecISon}}
+#' @return a \code{list} with the following fields: \item{_id}{id #} \item{_rev}{revision #} \item{created}{created on} \item{ip_address}{ip address of creaISon} \item{items}{list of items} \item{key_hash}{} \item{last_modified}{} \item{owner}{} \item{title}{} \item{type}{}.
+#' @param collection_id A Impact Story collecISon id
+#' @param as.csv Default is \code{FALSE}. Set to \code{TRUE} to return a .csv file. Use in conjuncISon with \code{\link{save_collection}}
#' @export
#' @examples \dontrun{
#' collection_metrics('kn5auf')
View
33 man/collection_metrics.Rd
@@ -0,0 +1,33 @@
+\name{collection_metrics}
+\alias{collection_metrics}
+\title{Retrives metadata on a valid Impact Story collecISon ID}
+\usage{
+ collection_metrics(collection_id = NULL, as.csv = FALSE)
+}
+\arguments{
+ \item{collection_id}{A Impact Story collecISon id}
+
+ \item{as.csv}{Default is \code{FALSE}. Set to \code{TRUE}
+ to return a .csv file. Use in conjuncISon with
+ \code{\link{save_collection}}}
+}
+\value{
+ a \code{list} with the following fields: \item{_id}{id #}
+ \item{_rev}{revision #} \item{created}{created on}
+ \item{ip_address}{ip address of creaISon}
+ \item{items}{list of items} \item{key_hash}{}
+ \item{last_modified}{} \item{owner}{} \item{title}{}
+ \item{type}{}.
+}
+\description{
+ Retrives metadata on a valid Impact Story collecISon ID
+}
+\examples{
+\dontrun{
+collection_metrics('kn5auf')
+}
+}
+\author{
+ Karthik Ram \email{karthik.ram@gmail.com}
+}
+
View
22 man/save_collection.Rd
@@ -0,0 +1,22 @@
+\name{save_collection}
+\alias{save_collection}
+\title{Saves metrics from a collection to a csv file}
+\usage{
+ save_collection(cid = NULL, file = NULL)
+}
+\arguments{
+ \item{cid}{A valid Impact Story collection ID}
+
+ \item{file}{A filename for the \code{csv} file including
+ path. If left blank, the file is named after the
+ collection and stored in the current working directory.}
+}
+\description{
+ Saves metrics from a collection to a csv file
+}
+\examples{
+\dontrun{
+save_collection('kn5auf', file = '~/Desktop/test.csv')
+}
+}
+

0 comments on commit 5c8daf4

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