Skip to content

Commit

Permalink
instruct user to install packages & removed checks
Browse files Browse the repository at this point in the history
  • Loading branch information
Katrin Leinweber committed Dec 20, 2014
1 parent e7748ce commit e5a639c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 18 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Usage Instructions
1. Click "Download as CSV".
1. Save them to a folder of your choice.
1. Download [this script](https://github.com/KonScience/Summarise-Flattr-Reports/blob/master/summarise-flattr-reports.R) to the same or any other folder.
1. Open the script (.r file) in RStudio.
1. Run it with `alt+cmd+R` (Mac) or `ctrl+alt+R` (Win).
1. Open RStudio, copy-paste this command `install.packages(c("plyr", "ggplot2", "scales"))` into the console (bottom left) and run it by pressing `Return/Enter`.
1. Open the script (.r file) in RStudio and run it with `alt + cmd + R` (Mac) or `ctrl + alt + R` (Win).
1. Follow its progress in RStudios' `Console` and `Plot` tabs. This may take few seconds to several minutes, depending on your number of Flattr Revenue Reports, data points in them, and the speed of your computer. Example: 20 Reports with 200 data points at [2.3 GHz](http://www.everymac.com/systems/apple/macbook_pro/specs/macbook-pro-core-i5-2.3-13-early-2011-unibody-thunderbolt-specs.html): 10sec.
1. Find the newly generated .csv files and .png diagrams in the same folder as the .csv files you downloaded from Flattr.
1. Please contribute ideas, criticism and code, by [opening an issue](https://github.com/KonScience/Summarize-Flattr-Reports/issues/new) or [forking](https://github.com/KonScience/Summarize-Flattr-Reports/fork) and sending a pull request. In particular, please let me know at which size of the dataset the diagrams become difficult to interpret.
Expand All @@ -30,7 +30,7 @@ Ideas
- predictions (anybody knows the statistics behind this?)
- episodes vs. other things (probably needs reg-ex on slugs)
- webapp via Shiny that processes given data ~~for a Flattr-click~~ [Not a good idea](https://stackoverflow.com/questions/8971918/using-flattr-as-paywall)
- install on server to auto-run & publish diagram
- install on server to auto-run & publish diagram

Thanks and Greetings :-)
---
Expand Down
16 changes: 1 addition & 15 deletions summarize-flattr-reports.R
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
# READ ME: https://github.com/KonScience/Summarize-Flattr-Reports#summarize-flattr-reports

# load packages for data frame manipulation & diagram drawing; learned from http://stackoverflow.com/a/9341735
# update.packages(checkBuilt = TRUE, ask = FALSE) # update all packages

if (!"scales" %in% installed.packages()) {
install.packages("scales")
}

if (!"ggplot2" %in% installed.packages()) {
install.packages("ggplot2")
}

if (!"plyr" %in% installed.packages()) {
install.packages("plyr")
}

# load packages for data frame manipulation & diagram drawing
# see http://www.r-bloggers.com/library-vs-require-in-r/ for require() vs. library() discussion
library(scales)
library(ggplot2)
Expand Down

1 comment on commit e5a639c

@katrinleinweber
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not about this change. What's a more sensible approach: Keep checks that are only required on first run in the code (bloating it), or out-source them to the read-me, hoping people notice?

Please sign in to comment.