Skip to content

Commit fa37a6d

Browse files
syoung-smallwisdomsyoung-smallwisdom
committed
Update documentation to include ResearchRecorders
1 parent 8e15477 commit fa37a6d

File tree

107 files changed

+26336
-59
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+26336
-59
lines changed

‎Documentation/ResearchRecorders/Classes.html‎

Lines changed: 424 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/ResearchRecorders/Classes/RSDDataLogger.html‎

Lines changed: 443 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/ResearchRecorders/Classes/RSDDistanceRecorder.html‎

Lines changed: 704 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/ResearchRecorders/Classes/RSDDistanceRecorder/CRFResultIdentifier.html‎

Lines changed: 265 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,265 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>CRFResultIdentifier Enumeration Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="../../js/jquery.min.js" defer></script>
9+
<script src="../../js/jazzy.js" defer></script>
10+
11+
</head>
12+
<body>
13+
<a name="//apple_ref/swift/Enum/CRFResultIdentifier" class="dashAnchor"></a>
14+
<a title="CRFResultIdentifier Enumeration Reference"></a>
15+
<header>
16+
<div class="content-wrapper">
17+
<p><a href="../../index.html">ResearchRecorders Docs</a></p>
18+
<p class="header-right"><a href="https://github.com/Sage-Bionetworks/SageResearch.git"><img src="../../img/gh.png"/>View on GitHub</a></p>
19+
</div>
20+
</header>
21+
<div class="content-wrapper">
22+
<p id="breadcrumbs">
23+
<a href="../../index.html">ResearchRecorders Reference</a>
24+
<img id="carat" src="../../img/carat.png" />
25+
CRFResultIdentifier Enumeration Reference
26+
</p>
27+
</div>
28+
<div class="content-wrapper">
29+
<nav class="sidebar">
30+
<ul class="nav-groups">
31+
<li class="nav-group-name">
32+
<a href="../../Classes.html">Classes</a>
33+
<ul class="nav-group-tasks">
34+
<li class="nav-group-task">
35+
<a href="../../Classes/RSDDataLogger.html">RSDDataLogger</a>
36+
</li>
37+
<li class="nav-group-task">
38+
<a href="../../Classes/RSDDistanceRecorder.html">RSDDistanceRecorder</a>
39+
</li>
40+
<li class="nav-group-task">
41+
<a href="../../Classes/RSDDistanceRecorder/CRFResultIdentifier.html">– CRFResultIdentifier</a>
42+
</li>
43+
<li class="nav-group-task">
44+
<a href="../../Classes/RSDMotionAuthorization.html">RSDMotionAuthorization</a>
45+
</li>
46+
<li class="nav-group-task">
47+
<a href="../../Classes/RSDMotionRecorder.html">RSDMotionRecorder</a>
48+
</li>
49+
<li class="nav-group-task">
50+
<a href="../../Classes/RSDRecordSampleLogger.html">RSDRecordSampleLogger</a>
51+
</li>
52+
<li class="nav-group-task">
53+
<a href="../../Classes/RSDRecordSampleLogger/RSDRecordSampleLoggerError.html">– RSDRecordSampleLoggerError</a>
54+
</li>
55+
<li class="nav-group-task">
56+
<a href="../../Classes/RSDSampleRecorder.html">RSDSampleRecorder</a>
57+
</li>
58+
<li class="nav-group-task">
59+
<a href="../../Classes/RSDSampleRecorder/RecorderError.html">– RecorderError</a>
60+
</li>
61+
</ul>
62+
</li>
63+
<li class="nav-group-name">
64+
<a href="../../Enums.html">Enumerations</a>
65+
<ul class="nav-group-tasks">
66+
<li class="nav-group-task">
67+
<a href="../../Enums/RSDAttitudeReferenceFrame.html">RSDAttitudeReferenceFrame</a>
68+
</li>
69+
</ul>
70+
</li>
71+
<li class="nav-group-name">
72+
<a href="../../Extensions.html">Extensions</a>
73+
<ul class="nav-group-tasks">
74+
<li class="nav-group-task">
75+
<a href="../../Extensions/CMAccelerometerData.html">CMAccelerometerData</a>
76+
</li>
77+
<li class="nav-group-task">
78+
<a href="../../Extensions/CMGyroData.html">CMGyroData</a>
79+
</li>
80+
<li class="nav-group-task">
81+
<a href="../../Extensions/CMMagnetometerData.html">CMMagnetometerData</a>
82+
</li>
83+
<li class="nav-group-task">
84+
<a href="../../Extensions/Notification.html">Notification</a>
85+
</li>
86+
<li class="nav-group-task">
87+
<a href="../../Extensions/Notification/Name.html">– Name</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a href="../../Extensions/RSDDistanceRecorderConfiguration.html">RSDDistanceRecorderConfiguration</a>
91+
</li>
92+
<li class="nav-group-task">
93+
<a href="../../Extensions/RSDIdentifier.html">RSDIdentifier</a>
94+
</li>
95+
<li class="nav-group-task">
96+
<a href="../../Extensions/RSDMotionRecorderConfiguration.html">RSDMotionRecorderConfiguration</a>
97+
</li>
98+
</ul>
99+
</li>
100+
<li class="nav-group-name">
101+
<a href="../../Protocols.html">Protocols</a>
102+
<ul class="nav-group-tasks">
103+
<li class="nav-group-task">
104+
<a href="../../Protocols/RSDSampleRecord.html">RSDSampleRecord</a>
105+
</li>
106+
<li class="nav-group-task">
107+
<a href="../../Protocols/RSDStringSeparatedEncodingFormat.html">RSDStringSeparatedEncodingFormat</a>
108+
</li>
109+
<li class="nav-group-task">
110+
<a href="../../Protocols.html#/s:17ResearchRecorders9RSDVectorP">RSDVector</a>
111+
</li>
112+
<li class="nav-group-task">
113+
<a href="../../Protocols/RSDVectorData.html">RSDVectorData</a>
114+
</li>
115+
</ul>
116+
</li>
117+
<li class="nav-group-name">
118+
<a href="../../Structs.html">Structures</a>
119+
<ul class="nav-group-tasks">
120+
<li class="nav-group-task">
121+
<a href="../../Structs/CSVEncodingFormat.html">CSVEncodingFormat</a>
122+
</li>
123+
<li class="nav-group-task">
124+
<a href="../../Structs/RSDAudioVisualAuthorization.html">RSDAudioVisualAuthorization</a>
125+
</li>
126+
<li class="nav-group-task">
127+
<a href="../../Structs/RSDDistanceRecord.html">RSDDistanceRecord</a>
128+
</li>
129+
<li class="nav-group-task">
130+
<a href="../../Structs/RSDLocationAuthorization.html">RSDLocationAuthorization</a>
131+
</li>
132+
<li class="nav-group-task">
133+
<a href="../../Structs/RSDMotionRecord.html">RSDMotionRecord</a>
134+
</li>
135+
<li class="nav-group-task">
136+
<a href="../../Structs/RSDPhotoLibraryAuthorization.html">RSDPhotoLibraryAuthorization</a>
137+
</li>
138+
<li class="nav-group-task">
139+
<a href="../../Structs/RSDRecordMarker.html">RSDRecordMarker</a>
140+
</li>
141+
</ul>
142+
</li>
143+
</ul>
144+
</nav>
145+
<article class="main-content">
146+
<section>
147+
<section class="section">
148+
<h1>CRFResultIdentifier</h1>
149+
<div class="declaration">
150+
<div class="language">
151+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">CRFResultIdentifier</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span></code></pre>
152+
153+
</div>
154+
</div>
155+
<p>The result identifiers used for the additional results recorded
156+
by the distance recorder.</p>
157+
158+
</section>
159+
<section class="section task-group-section">
160+
<div class="task-group">
161+
<ul>
162+
<li class="item">
163+
<div>
164+
<code>
165+
<a name="/s:17ResearchRecorders19RSDDistanceRecorderC19CRFResultIdentifierO9stepCountyA2EmF"></a>
166+
<a name="//apple_ref/swift/Element/stepCount" class="dashAnchor"></a>
167+
<a class="token" href="#/s:17ResearchRecorders19RSDDistanceRecorderC19CRFResultIdentifierO9stepCountyA2EmF">stepCount</a>
168+
</code>
169+
</div>
170+
<div class="height-container">
171+
<div class="pointer-container"></div>
172+
<section class="section">
173+
<div class="pointer"></div>
174+
<div class="abstract">
175+
<p>The step count returned by the pedometer.</p>
176+
177+
</div>
178+
<div class="declaration">
179+
<h4>Declaration</h4>
180+
<div class="language">
181+
<p class="aside-title">Swift</p>
182+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">stepCount</span></code></pre>
183+
184+
</div>
185+
</div>
186+
</section>
187+
</div>
188+
</li>
189+
<li class="item">
190+
<div>
191+
<code>
192+
<a name="/s:17ResearchRecorders19RSDDistanceRecorderC19CRFResultIdentifierO17pedometerDistanceyA2EmF"></a>
193+
<a name="//apple_ref/swift/Element/pedometerDistance" class="dashAnchor"></a>
194+
<a class="token" href="#/s:17ResearchRecorders19RSDDistanceRecorderC19CRFResultIdentifierO17pedometerDistanceyA2EmF">pedometerDistance</a>
195+
</code>
196+
</div>
197+
<div class="height-container">
198+
<div class="pointer-container"></div>
199+
<section class="section">
200+
<div class="pointer"></div>
201+
<div class="abstract">
202+
<p>The distance measurement returned by the pedometer.</p>
203+
204+
</div>
205+
<div class="declaration">
206+
<h4>Declaration</h4>
207+
<div class="language">
208+
<p class="aside-title">Swift</p>
209+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">pedometerDistance</span></code></pre>
210+
211+
</div>
212+
</div>
213+
</section>
214+
</div>
215+
</li>
216+
<li class="item">
217+
<div>
218+
<code>
219+
<a name="/s:17ResearchRecorders19RSDDistanceRecorderC19CRFResultIdentifierO11gpsDistanceyA2EmF"></a>
220+
<a name="//apple_ref/swift/Element/gpsDistance" class="dashAnchor"></a>
221+
<a class="token" href="#/s:17ResearchRecorders19RSDDistanceRecorderC19CRFResultIdentifierO11gpsDistanceyA2EmF">gpsDistance</a>
222+
</code>
223+
</div>
224+
<div class="height-container">
225+
<div class="pointer-container"></div>
226+
<section class="section">
227+
<div class="pointer"></div>
228+
<div class="abstract">
229+
<p>The total distance measured by summing the relative distance travelled during the
230+
motion step (when the participant is expected to be moving).</p>
231+
<div class="aside aside-note">
232+
<p class="aside-title">Note</p>
233+
it is possible to <q>game</q> this result because the calculation of this result
234+
does not account for coordinate measurement accuracy or the course and speed at which
235+
the user is travelling. It is used only to give feedback to a partipant. The pedometer
236+
distance and a path constructed by using the course, speed, and relative distance
237+
recorded samples should be used by a research study for more accurate data collection.
238+
239+
</div>
240+
241+
</div>
242+
<div class="declaration">
243+
<h4>Declaration</h4>
244+
<div class="language">
245+
<p class="aside-title">Swift</p>
246+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">gpsDistance</span></code></pre>
247+
248+
</div>
249+
</div>
250+
</section>
251+
</div>
252+
</li>
253+
</ul>
254+
</div>
255+
</section>
256+
</section>
257+
<section id="footer">
258+
<p>&copy; 2017-2019 <a class="link" href="https://developer.sagebridge.org" target="_blank" rel="external">Sage Bionetworks</a>. All rights reserved.</p>
259+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
260+
</section>
261+
</article>
262+
</div>
263+
</body>
264+
</div>
265+
</html>

0 commit comments

Comments
 (0)