Skip to content

Commit 215364a

Browse files
jeroenjeroen
committed
first commit
0 parents  commit 215364a

34 files changed

+2655
-0
lines changed

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.Rproj.user
2+
.Rhistory
3+
.RData
4+
.Ruserdata
5+
mongobook/_bookdown_files
6+

‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.opencpu.org

‎get-started.html

+221
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
<!DOCTYPE html>
2+
<html >
3+
4+
<head>
5+
6+
<meta charset="UTF-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
8+
<title>OpenCPU User Manual</title>
9+
<meta name="description" content="OpenCPU: Producing and Reproducing Results">
10+
<meta name="generator" content="bookdown 0.4.1 and GitBook 2.6.7">
11+
12+
<meta property="og:title" content="OpenCPU User Manual" />
13+
<meta property="og:type" content="book" />
14+
15+
16+
<meta property="og:description" content="OpenCPU: Producing and Reproducing Results" />
17+
<meta name="github-repo" content="opencpu/opencpu.github.io" />
18+
19+
<meta name="twitter:card" content="summary" />
20+
<meta name="twitter:title" content="OpenCPU User Manual" />
21+
22+
<meta name="twitter:description" content="OpenCPU: Producing and Reproducing Results" />
23+
24+
25+
26+
27+
28+
<meta name="viewport" content="width=device-width, initial-scale=1">
29+
<meta name="apple-mobile-web-app-capable" content="yes">
30+
<meta name="apple-mobile-web-app-status-bar-style" content="black">
31+
32+
33+
<link rel="prev" href="index.html">
34+
<link rel="next" href="opencpu-server.html">
35+
<script src="libs/jquery-2.2.3/jquery.min.js"></script>
36+
<link href="libs/gitbook-2.6.7/css/style.css" rel="stylesheet" />
37+
<link href="libs/gitbook-2.6.7/css/plugin-bookdown.css" rel="stylesheet" />
38+
<link href="libs/gitbook-2.6.7/css/plugin-highlight.css" rel="stylesheet" />
39+
<link href="libs/gitbook-2.6.7/css/plugin-search.css" rel="stylesheet" />
40+
<link href="libs/gitbook-2.6.7/css/plugin-fontsettings.css" rel="stylesheet" />
41+
42+
43+
44+
45+
46+
47+
48+
49+
50+
<style type="text/css">
51+
div.sourceCode { overflow-x: auto; }
52+
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
53+
margin: 0; padding: 0; vertical-align: baseline; border: none; }
54+
table.sourceCode { width: 100%; line-height: 100%; }
55+
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
56+
td.sourceCode { padding-left: 5px; }
57+
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
58+
code > span.dt { color: #902000; } /* DataType */
59+
code > span.dv { color: #40a070; } /* DecVal */
60+
code > span.bn { color: #40a070; } /* BaseN */
61+
code > span.fl { color: #40a070; } /* Float */
62+
code > span.ch { color: #4070a0; } /* Char */
63+
code > span.st { color: #4070a0; } /* String */
64+
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
65+
code > span.ot { color: #007020; } /* Other */
66+
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
67+
code > span.fu { color: #06287e; } /* Function */
68+
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
69+
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
70+
code > span.cn { color: #880000; } /* Constant */
71+
code > span.sc { color: #4070a0; } /* SpecialChar */
72+
code > span.vs { color: #4070a0; } /* VerbatimString */
73+
code > span.ss { color: #bb6688; } /* SpecialString */
74+
code > span.im { } /* Import */
75+
code > span.va { color: #19177c; } /* Variable */
76+
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
77+
code > span.op { color: #666666; } /* Operator */
78+
code > span.bu { } /* BuiltIn */
79+
code > span.ex { } /* Extension */
80+
code > span.pp { color: #bc7a00; } /* Preprocessor */
81+
code > span.at { color: #7d9029; } /* Attribute */
82+
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
83+
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
84+
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
85+
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
86+
</style>
87+
88+
<link rel="stylesheet" href="style.css" type="text/css" />
89+
</head>
90+
91+
<body>
92+
93+
94+
95+
<div class="book without-animation with-summary font-size-2 font-family-1" data-basepath=".">
96+
97+
<div class="book-summary">
98+
<nav role="navigation">
99+
100+
<ul class="summary">
101+
<li><a href="./">OpenCPU User Manual</a></li>
102+
103+
<li class="divider"></li>
104+
<li class="chapter" data-level="1" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i><b>1</b> Welcome</a><ul>
105+
<li class="chapter" data-level="1.1" data-path="index.html"><a href="index.html#why-opencpu"><i class="fa fa-check"></i><b>1.1</b> Why OpenCPU</a></li>
106+
<li class="chapter" data-level="1.2" data-path="index.html"><a href="index.html#pieces"><i class="fa fa-check"></i><b>1.2</b> Pieces</a></li>
107+
<li class="chapter" data-level="1.3" data-path="index.html"><a href="index.html#information-and-support"><i class="fa fa-check"></i><b>1.3</b> Information and support</a></li>
108+
</ul></li>
109+
<li class="chapter" data-level="2" data-path="get-started.html"><a href="get-started.html"><i class="fa fa-check"></i><b>2</b> Get started</a><ul>
110+
<li class="chapter" data-level="2.1" data-path="get-started.html"><a href="get-started.html#hello-world"><i class="fa fa-check"></i><b>2.1</b> Hello world</a></li>
111+
<li class="chapter" data-level="2.2" data-path="get-started.html"><a href="get-started.html#what-are-apps"><i class="fa fa-check"></i><b>2.2</b> What are apps</a></li>
112+
<li class="chapter" data-level="2.3" data-path="get-started.html"><a href="get-started.html#a-development-environment"><i class="fa fa-check"></i><b>2.3</b> A development environment</a></li>
113+
<li class="chapter" data-level="2.4" data-path="get-started.html"><a href="get-started.html#deployment"><i class="fa fa-check"></i><b>2.4</b> Deployment</a></li>
114+
</ul></li>
115+
<li class="chapter" data-level="3" data-path="opencpu-server.html"><a href="opencpu-server.html"><i class="fa fa-check"></i><b>3</b> OpenCPU Server</a><ul>
116+
<li class="chapter" data-level="3.1" data-path="opencpu-server.html"><a href="opencpu-server.html#installation"><i class="fa fa-check"></i><b>3.1</b> Installation</a></li>
117+
<li class="chapter" data-level="3.2" data-path="opencpu-server.html"><a href="opencpu-server.html#configuring"><i class="fa fa-check"></i><b>3.2</b> Configuring</a></li>
118+
</ul></li>
119+
<li class="divider"></li>
120+
<li><a href="https://github.com/opencpu/opencpu.github.io" target="blank">(c) Jeroen Ooms, 2017</a></li>
121+
122+
</ul>
123+
124+
</nav>
125+
</div>
126+
127+
<div class="book-body">
128+
<div class="body-inner">
129+
<div class="book-header" role="navigation">
130+
<h1>
131+
<i class="fa fa-circle-o-notch fa-spin"></i><a href="./">OpenCPU User Manual</a>
132+
</h1>
133+
</div>
134+
135+
<div class="page-wrapper" tabindex="-1" role="main">
136+
<div class="page-inner">
137+
138+
<section class="normal" id="section-">
139+
<div id="get-started" class="section level1">
140+
<h1><span class="header-section-number">Chapter 2</span> Get started</h1>
141+
<p>Steps to develop apps:</p>
142+
<ol style="list-style-type: decimal">
143+
<li>Create R package with your stuff</li>
144+
<li>Expose via OpenCPU single user server</li>
145+
<li>Deploy via public server or docker or elsewhere</li>
146+
</ol>
147+
<div id="hello-world" class="section level2">
148+
<h2><span class="header-section-number">2.1</span> Hello world</h2>
149+
<ol style="list-style-type: decimal">
150+
<li>Start a single-user server</li>
151+
<li>Run some apps</li>
152+
<li>Poke around with <code>curl</code> or the test page.</li>
153+
<li>Get some objects in formats, do rpc, post data. Reuse objects from session.</li>
154+
</ol>
155+
</div>
156+
<div id="what-are-apps" class="section level2">
157+
<h2><span class="header-section-number">2.2</span> What are apps</h2>
158+
</div>
159+
<div id="a-development-environment" class="section level2">
160+
<h2><span class="header-section-number">2.3</span> A development environment</h2>
161+
<p>Need to build packages. RStudio is very convenient. Either single user environment or docker will work.</p>
162+
</div>
163+
<div id="deployment" class="section level2">
164+
<h2><span class="header-section-number">2.4</span> Deployment</h2>
165+
<p>Either:</p>
166+
<ol style="list-style-type: decimal">
167+
<li>Deploy on public server</li>
168+
<li>Run your own</li>
169+
</ol>
170+
171+
</div>
172+
</div>
173+
</section>
174+
175+
</div>
176+
</div>
177+
</div>
178+
<a href="index.html" class="navigation navigation-prev " aria-label="Previous page"><i class="fa fa-angle-left"></i></a>
179+
<a href="opencpu-server.html" class="navigation navigation-next " aria-label="Next page"><i class="fa fa-angle-right"></i></a>
180+
</div>
181+
</div>
182+
<script src="libs/gitbook-2.6.7/js/app.min.js"></script>
183+
<script src="libs/gitbook-2.6.7/js/lunr.js"></script>
184+
<script src="libs/gitbook-2.6.7/js/plugin-search.js"></script>
185+
<script src="libs/gitbook-2.6.7/js/plugin-sharing.js"></script>
186+
<script src="libs/gitbook-2.6.7/js/plugin-fontsettings.js"></script>
187+
<script src="libs/gitbook-2.6.7/js/plugin-bookdown.js"></script>
188+
<script src="libs/gitbook-2.6.7/js/jquery.highlight.js"></script>
189+
<script>
190+
gitbook.require(["gitbook"], function(gitbook) {
191+
gitbook.start({
192+
"sharing": {
193+
"github": false,
194+
"facebook": true,
195+
"twitter": true,
196+
"google": false,
197+
"weibo": false,
198+
"instapper": false,
199+
"vk": false,
200+
"all": ["facebook", "google", "twitter", "weibo", "instapaper"]
201+
},
202+
"fontsettings": {
203+
"theme": "white",
204+
"family": "sans",
205+
"size": 2
206+
},
207+
"edit": {
208+
"link": "https://github.com/rstudio/bookdown-demo/edit/master/01-get-started.Rmd",
209+
"text": "Edit"
210+
},
211+
"download": null,
212+
"toc": {
213+
"collapse": "subsection"
214+
}
215+
});
216+
});
217+
</script>
218+
219+
</body>
220+
221+
</html>

0 commit comments

Comments
 (0)