This repository has been archived by the owner on May 10, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
Showing
5 changed files
with
61 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ Imports: | |
plyr | ||
Collate: | ||
'getMetrics.R' | ||
'collection.R' | ||
'api_info.R' | ||
'tiID.R' | ||
'ti_providers.R' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
export(IS_providers) | ||
export(ISid) | ||
export(about_IS) | ||
export(collection_metrics) | ||
export(create_ISid) | ||
export(metrics) | ||
export(save_collection) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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} | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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') | ||
} | ||
} | ||
|