README.md
1RAPPOR Shiny Apps
2=================
3
4This directory contains web apps written using the [Shiny][shiny] web framework
5from [RStudio][rstudio].
6
7To run them, first install Shiny:
8
9 $ R
10 ...
11 > install.packages('shiny')
12 ...
13
14(You can view Shiny's platform requirements in
15[CRAN](http://cran.r-project.org/web/packages/shiny/index.html).)
16
17Then change to the app directory, and execute the `run_app.sh` script:
18
19 $ cd rappor/apps/rappor-analysis
20 $ ./run_app.sh
21 ...
22 Listening on http://0.0.0.0.:6789
23
24Visit http://localhost:6789/ in your browser.
25
26This code has been tested on Ubuntu Linux, but should work on other platforms
27that Shiny supports.
28
29Both of these apps use the underlying analysis code in `analysis/R`, just like
30the command line demo `demo.sh` does.
31
32rappor-analysis
33---------------
34
35This app "decodes" a RAPPOR data set. In other words, you can upload the
36`params`, `counts`, and `map` files, and view the inferred distribution, as
37well as debug info.
38
39These files are discussed in the RAPPOR [Data Flow][data-flow] doc.
40
41rappor-sim
42----------
43
44This app lets you simulate RAPPOR runs with different populations and
45parameters. This can help you choose collection parameters for a given
46situation / variable.
47
48Help
49----
50
51If you need help with these apps, please send a message to
52[rappor-discuss][group].
53
54
55[shiny]: http://shiny.rstudio.com/
56[rstudio]: http://rstudio.com/
57[data-flow]: http://google.github.io/rappor/doc/data-flow.html
58[group]: https://groups.google.com/forum/#!forum/rappor-discuss
59