boB Rudis 5 years ago
parent
commit
e115b6d80e
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
  1. 9
      DESCRIPTION
  2. 10
      R/mediacloud-package.R
  3. 6
      README.Rmd
  4. 61
      README.md
  5. 12
      man/mediacloud.Rd

9
DESCRIPTION

@ -1,12 +1,17 @@
Package: mediacloud
Type: Package
Title: mediacloud title goes here otherwise CRAN checks fail
Title: Tools to Query the 'Media Cloud' 'API'
Version: 0.1.0
Date: 2019-07-21
Authors@R: c( person("Bob", "Rudis", email = "bob@rud.is", role =
c("aut", "cre"), comment = c(ORCID = "0000-0001-5670-2640")) )
Maintainer: Bob Rudis <bob@rud.is>
Description: A good description goes here otherwise CRAN checks fail.
Description: 'Media Cloud' (<https://mediacloud.org/>) is an open source platform
for studying media ecosystems. By tracking millions of stories published online,
their suite of tools allows researchers to track how stories and ideas spread
through media and help researchers answer complex quantitative and qualitative
questions about the content of online media. Methods are provided to query
the 'Media Cloud' 'API'.
URL: https://gitlab.com/hrbrmstr/mediacloud
BugReports: https://gitlab.com/hrbrmstr/mediacloud/issues
Encoding: UTF-8

10
R/mediacloud-package.R

@ -1,7 +1,11 @@
#' ...
#' Tools to Query the 'Media Cloud' 'API'
#'
#' - URL: <https://gitlab.com/hrbrmstr/mediacloud>
#' - BugReports: <https://gitlab.com/hrbrmstr/mediacloud/issues>
#' 'Media Cloud' (<https://mediacloud.org/>) is an open source platform
#' for studying media ecosystems. By tracking millions of stories published online,
#' their suite of tools allows researchers to track how stories and ideas spread
#' through media and help researchers answer complex quantitative and qualitative
#' questions about the content of online media. Methods are provided to query
#' the 'Media Cloud' 'API'.
#'
#' @md
#' @name mediacloud

6
README.Rmd

@ -14,10 +14,14 @@ options(width=120)
[![Coverage Status](https://codecov.io/gh/hrbrmstr/mediacloud/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/mediacloud)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/mediacloud)](https://cran.r-project.org/package=mediacloud)
# mediacloud
# mediacloud [WIP]
Tools to Query the 'Media Cloud' 'API'
## Description
'Media Cloud' (<https://mediacloud.org/>) is an open source platform for studying media ecosystems. By tracking millions of stories published online, their suite of tools allows researchers to track how stories and ideas spread through media and help researchers answer complex quantitative and qualitative questions about the content of online media. Methods are provided to query the 'Media Cloud' 'API'.
## What's Inside The Tin
The following functions are implemented:

61
README.md

@ -1,2 +1,61 @@
# mediacloud
[![Travis-CI Build
Status](https://travis-ci.org/hrbrmstr/mediacloud.svg?branch=master)](https://travis-ci.org/hrbrmstr/mediacloud)
[![Coverage
Status](https://codecov.io/gh/hrbrmstr/mediacloud/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/mediacloud)
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/mediacloud)](https://cran.r-project.org/package=mediacloud)
# mediacloud \[WIP\]
Tools to Query the ‘Media Cloud’ ‘API’
## Description
‘Media Cloud’ (<https://mediacloud.org/>) is an open source platform for
studying media ecosystems. By tracking millions of stories published
online, their suite of tools allows researchers to track how stories and
ideas spread through media and help researchers answer complex
quantitative and qualitative questions about the content of online
media. Methods are provided to query the ‘Media Cloud’ ‘API’.
## What’s Inside The Tin
The following functions are implemented:
- `mc_media_list`: Return multiple media sources
- `mc_stats`: Return basic summary stats about total sources, stories,
feeds, etc processed by Media Cloud
- `mediacloud_api_key`: Get or set MEDIACLOUD\_API\_KEY value
## Installation
``` r
devtools::install_git("https://git.sr.ht/~hrbrmstr/mediacloud")
# or
devtools::install_gitlab("hrbrmstr/mediacloud")
# or
devtools::install_bitbucket("hrbrmstr/mediacloud")
```
## Usage
``` r
library(mediacloud)
# current version
packageVersion("mediacloud")
## [1] '0.1.0'
```
## mediacloud Metrics
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) |
| :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: |
| R | 7 | 0.88 | 115 | 0.93 | 33 | 0.65 | 115 | 0.79 |
| Rmd | 1 | 0.12 | 9 | 0.07 | 18 | 0.35 | 31 | 0.21 |
## Code of Conduct
Please note that this project is released with a [Contributor Code of
Conduct](CONDUCT.md). By participating in this project you agree to
abide by its terms.

12
man/mediacloud.Rd

@ -4,12 +4,14 @@
\name{mediacloud}
\alias{mediacloud}
\alias{mediacloud-package}
\title{...}
\title{Tools to Query the 'Media Cloud' 'API'}
\description{
\itemize{
\item URL: \url{https://gitlab.com/hrbrmstr/mediacloud}
\item BugReports: \url{https://gitlab.com/hrbrmstr/mediacloud/issues}
}
'Media Cloud' (\url{https://mediacloud.org/}) is an open source platform
for studying media ecosystems. By tracking millions of stories published online,
their suite of tools allows researchers to track how stories and ideas spread
through media and help researchers answer complex quantitative and qualitative
questions about the content of online media. Methods are provided to query
the 'Media Cloud' 'API'.
}
\seealso{
Useful links:

Loading…
Cancel
Save