Holds Rmd files and compiler for voteview blog
Switch branches/tags
Nothing to show
Clone or download

README.md

Build Status

voteview.com article repository

This repository contains the source documents for the articles, help messages, and blog posts used on voteview.com. We welcome user contributions!

How to contribute

To contribute, follow these simple steps:

  1. Fork our repository or clone the "example" branch.
  2. Rename the articles/blank folder to a short stub name suitable for your contribution.
  3. Inside, rename blank.Rmd to match the folder name, and use it as a template for your article.
  4. Open article.Rproj and run compiler.R to verify your article compiles correctly.
  5. Open a pull request merging your local branch into voteview/articles/master
  6. Wait for automatic integration testing to verify your pull request, and for us to approve it.

Contribution guidelines

We welcome user contributions which meet the following requirements:

  1. Articles must be written in English
  2. Articles must use Voteview data or NOMINATE estimation to produce either a new, derived dataset or examine a problem of political, journalistic, or social interest.
  3. Code must be non-destructive, must not modify files outside the article's folder, and must contain clearly documented and easily understood functionality.
  4. Articles must be submitted as a GitHub pull request to this repository.
  5. Articles must be submitted by their authors.

We reserve the right to reject submissions for any reason, with or without feedback.

License

The content of this repository is available under the MIT license. By submitting a contribution to this repository, you are granting Voteview / UCLA certain irrevocable non-exclusive rights to display your contribution on voteview.com or related sites, or to promote or advertise your contribution in connection with the site. We will preserve and display author metadata that you submit along with your article.

File and directory structure

The structure of this repository is as follows:

  • compiler.R: Script that handles RMarkdown compilation and output for articles, as well as JSON metadata generation
  • docs/: Folder containing subfolders for each article.
  • docs/<article>/: All files required to compile an article should go in this folder; working directory reflects this.
  • docs/<article>/<article>.Rmd: Main Rmd file to compile an article.
  • output_template/template_stub.html: Template HTML stub, which is used with RMarkdown to generate our HTML output.
  • articles.Rproj: R Project file for this repository.
  • .travis.yml: Configuration info for Travis CI.
  • .gitignore: Github file ignore information
  • README.md: This file