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