caruby-tissue 1.2.1 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. data/History.txt +4 -0
  2. data/LICENSE +1 -1
  3. data/README.md +79 -30
  4. data/bin/crtmigrate +2 -2
  5. data/{examples/galena/bin → bin}/migrate.rb +0 -0
  6. data/bin/seed +26 -0
  7. data/bin/seed.rb +43 -0
  8. data/conf/extract/simple_fields.yaml +4 -0
  9. data/conf/migration/filter_fields.yaml +7 -0
  10. data/{examples/galena/conf → conf}/migration/filter_migration.yaml +0 -0
  11. data/conf/migration/frozen_fields.yaml +11 -0
  12. data/{examples/galena/conf → conf}/migration/frozen_migration.yaml +0 -0
  13. data/conf/migration/general_fields.yaml +44 -0
  14. data/{examples/galena/conf → conf}/migration/general_migration.yaml +0 -0
  15. data/conf/migration/simple_fields.yaml +30 -0
  16. data/{examples/galena/conf → conf}/migration/simple_migration.yaml +0 -0
  17. data/{examples/galena/conf → conf}/migration/small_fields.yaml +0 -0
  18. data/{examples/galena/conf → conf}/migration/small_migration.yaml +0 -0
  19. data/examples/galena/README.md +46 -6
  20. data/examples/galena/bin/seed +26 -0
  21. data/examples/galena/conf/migration/frozen_fields.yaml +1 -0
  22. data/examples/galena/conf/migration/general_fields.yaml +2 -0
  23. data/examples/galena/data/filter.csv +1 -1
  24. data/examples/galena/data/frozen.csv +1 -1
  25. data/examples/galena/data/general.csv +1 -1
  26. data/examples/galena/doc/CaTissue.html +2 -2
  27. data/examples/galena/doc/CaTissue/Participant.html +1 -1
  28. data/examples/galena/doc/CaTissue/SpecimenCollectionGroup.html +1 -1
  29. data/examples/galena/doc/CaTissue/StorageContainer.html +6 -6
  30. data/examples/galena/doc/CaTissue/TissueSpecimen.html +1 -1
  31. data/examples/galena/doc/Galena.html +4 -122
  32. data/examples/galena/doc/Galena/Seed.html +1 -1
  33. data/examples/galena/doc/Galena/Seed/Defaults.html +28 -24
  34. data/examples/galena/doc/_index.html +1 -8
  35. data/examples/galena/doc/class_list.html +1 -1
  36. data/examples/galena/doc/file.README.html +52 -7
  37. data/examples/galena/doc/index.html +52 -7
  38. data/examples/galena/doc/method_list.html +9 -25
  39. data/examples/galena/doc/top-level-namespace.html +1 -1
  40. data/examples/galena/lib/galena/migration/frozen_shims.rb +4 -15
  41. data/examples/galena/lib/galena/seed/defaults.rb +16 -4
  42. data/{examples/galena/lib → lib}/README.html +0 -0
  43. data/lib/catissue/cli/command.rb +6 -9
  44. data/lib/catissue/cli/migrate.rb +11 -10
  45. data/lib/catissue/cli/smoke.rb +5 -5
  46. data/lib/catissue/database.rb +31 -8
  47. data/lib/catissue/domain/abstract_specimen.rb +1 -1
  48. data/lib/catissue/domain/collection_protocol.rb +29 -13
  49. data/lib/catissue/domain/participant_medical_identifier.rb +1 -1
  50. data/lib/catissue/domain/site.rb +3 -0
  51. data/lib/catissue/domain/specimen.rb +17 -14
  52. data/lib/catissue/domain/specimen_collection_group.rb +2 -5
  53. data/lib/catissue/extract/delta.rb +2 -6
  54. data/lib/catissue/migration/migrator.rb +6 -0
  55. data/lib/catissue/resource.rb +5 -2
  56. data/lib/catissue/util/log.rb +3 -3
  57. data/lib/catissue/version.rb +1 -1
  58. data/{examples/galena/lib → lib}/galena.rb +0 -0
  59. data/{examples/galena/bin → lib/galena/cli}/seed.rb +1 -1
  60. data/lib/galena/migration/filter_shims.rb +43 -0
  61. data/lib/galena/migration/frozen_shims.rb +53 -0
  62. data/lib/galena/seed/defaults.rb +109 -0
  63. metadata +27 -17
  64. data/examples/galena/doc/CaTissue/CollectionProtocolRegistration.html +0 -181
@@ -29,6 +29,8 @@ Diagnosis: SpecimenCollectionGroup.clinical_diagnosis
29
29
 
30
30
  Anatomic Site: SpecimenCharacteristics.tissue_site
31
31
 
32
+ Development: TissueSpecimen.pathological_status
33
+
32
34
  Label: TissueSpecimen.label
33
35
 
34
36
  Type: TissueSpecimen.specimen_type
@@ -1 +1 @@
1
- Protocol,MRN,Initials,Frozen?,SPN,Collection Date,Quantity
1
+ Protocol,MRN,Initials,Frozen?,SPN,Collection Date,Quantity
@@ -1 +1 @@
1
- MRN,SPN,Collection Date,Quantity,Box,X,Y
1
+ Protocol,MRN,SPN,Collection Date,Quantity,Box,X,Y
@@ -1 +1 @@
1
- Protocol,Collection Site,MRN,First Name,Last Name,PPI,SPN,Collection Point,Receiver,Received Timestamp,Collector,Collected Timestamp,Diagnosis,Anatomic Site,Label,Type,Quantity,Box,X,Y
1
+ Protocol,Collection Site,MRN,First Name,Last Name,PPI,SPN,Collection Point,Receiver,Received Timestamp,Collector,Collected Timestamp,Diagnosis,Anatomic Site,Development,Label,Type,Quantity,Box,X,Y
@@ -72,7 +72,7 @@
72
72
 
73
73
 
74
74
 
75
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="CaTissue/CollectionProtocolRegistration.html" title="CaTissue::CollectionProtocolRegistration (class)">CollectionProtocolRegistration</a></span>, <span class='object_link'><a href="CaTissue/Participant.html" title="CaTissue::Participant (class)">Participant</a></span>, <span class='object_link'><a href="CaTissue/SpecimenCollectionGroup.html" title="CaTissue::SpecimenCollectionGroup (class)">SpecimenCollectionGroup</a></span>, <span class='object_link'><a href="CaTissue/StorageContainer.html" title="CaTissue::StorageContainer (class)">StorageContainer</a></span>, <span class='object_link'><a href="CaTissue/TissueSpecimen.html" title="CaTissue::TissueSpecimen (class)">TissueSpecimen</a></span>
75
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="CaTissue/Participant.html" title="CaTissue::Participant (class)">Participant</a></span>, <span class='object_link'><a href="CaTissue/SpecimenCollectionGroup.html" title="CaTissue::SpecimenCollectionGroup (class)">SpecimenCollectionGroup</a></span>, <span class='object_link'><a href="CaTissue/StorageContainer.html" title="CaTissue::StorageContainer (class)">StorageContainer</a></span>, <span class='object_link'><a href="CaTissue/TissueSpecimen.html" title="CaTissue::TissueSpecimen (class)">TissueSpecimen</a></span>
76
76
 
77
77
 
78
78
  </p>
@@ -84,7 +84,7 @@
84
84
  </div>
85
85
 
86
86
  <div id="footer">
87
- Generated on Tue Nov 23 11:38:43 2010 by
87
+ Generated on Tue Nov 30 11:09:43 2010 by
88
88
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
89
89
  0.6.1 (ruby-1.8.6).
90
90
  </div>
@@ -232,7 +232,7 @@ Extracts the Participant last name from the <tt>Initials</tt> input field.
232
232
  </div>
233
233
 
234
234
  <div id="footer">
235
- Generated on Tue Nov 23 11:38:43 2010 by
235
+ Generated on Tue Nov 30 11:09:42 2010 by
236
236
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
237
237
  0.6.1 (ruby-1.8.6).
238
238
  </div>
@@ -181,7 +181,7 @@ Returns whether this SCG has a SPN.
181
181
  </div>
182
182
 
183
183
  <div id="footer">
184
- Generated on Tue Nov 23 11:38:43 2010 by
184
+ Generated on Tue Nov 30 11:09:43 2010 by
185
185
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186
186
  0.6.1 (ruby-1.8.6).
187
187
  </div>
@@ -147,13 +147,13 @@ Creates the migrated box in the database, if necessary.
147
147
  <pre class="lines">
148
148
 
149
149
 
150
- 32
151
- 33
152
- 34
153
- 35</pre>
150
+ 22
151
+ 23
152
+ 24
153
+ 25</pre>
154
154
  </td>
155
155
  <td>
156
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/migration/frozen_shims.rb', line 32</span>
156
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/migration/frozen_shims.rb', line 22</span>
157
157
 
158
158
  <span class='def def kw'>def</span> <span class='migrate identifier id'>migrate</span><span class='lparen token'>(</span><span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='migrated identifier id'>migrated</span><span class='rparen token'>)</span>
159
159
  <span class='super super kw'>super</span>
@@ -170,7 +170,7 @@ Creates the migrated box in the database, if necessary.
170
170
  </div>
171
171
 
172
172
  <div id="footer">
173
- Generated on Tue Nov 23 11:38:43 2010 by
173
+ Generated on Tue Nov 30 11:09:43 2010 by
174
174
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
175
175
  0.6.1 (ruby-1.8.6).
176
176
  </div>
@@ -311,7 +311,7 @@ type <tt>Frozen Tissue</tt> value.
311
311
  </div>
312
312
 
313
313
  <div id="footer">
314
- Generated on Tue Nov 23 11:38:43 2010 by
314
+ Generated on Tue Nov 30 11:09:43 2010 by
315
315
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
316
316
  0.6.1 (ruby-1.8.6).
317
317
  </div>
@@ -59,25 +59,12 @@
59
59
 
60
60
 
61
61
  <dt class="r1 last">Defined in:</dt>
62
- <dd class="r1 last">examples/galena/lib/galena.rb<span class="defines">,<br />
63
- examples/galena/lib/galena/seed/defaults.rb</span>
64
- </dd>
62
+ <dd class="r1 last">examples/galena/lib/galena/seed/defaults.rb</dd>
65
63
 
66
64
  </dl>
67
65
  <div class="clear"></div>
68
66
 
69
- <h2>Overview</h2><div class="docstring">
70
- <div class="discussion">
71
- <p>
72
- The caRuby Tissue Galena example module.
73
- </p>
74
-
75
-
76
- </div>
77
- </div>
78
- <div class="tags">
79
-
80
- </div><h2>Defined Under Namespace</h2>
67
+ <h2>Defined Under Namespace</h2>
81
68
  <p class="children">
82
69
 
83
70
 
@@ -101,30 +88,6 @@ The caRuby Tissue Galena example module.
101
88
  <li class="public ">
102
89
  <span class="summary_signature">
103
90
 
104
- <a href="#resource-class_method" title="resource (class method)">+ (String<sup>?</sup>) <strong>resource</strong>(path) </a>
105
-
106
-
107
-
108
- </span>
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
- <span class="summary_desc"><div class='inline'><p>
118
- The file in this gem which matches the given path.
119
- </p>
120
- </div></span>
121
-
122
- </li>
123
-
124
-
125
- <li class="public ">
126
- <span class="summary_signature">
127
-
128
91
  <a href="#seed-class_method" title="seed (class method)">+ (Object) <strong>seed</strong> </a>
129
92
 
130
93
 
@@ -156,88 +119,7 @@ Creates the <span class='object_link'><a href="Galena/Seed/Defaults.html" title=
156
119
 
157
120
 
158
121
  <div class="method_details first">
159
- <p class="signature first" id="resource-class_method">
160
-
161
- + (<tt>String</tt><sup>?</sup>) <strong>resource</strong>(path)
162
-
163
-
164
-
165
- </p><div class="docstring">
166
- <div class="discussion">
167
- <p>
168
- The file in this gem which matches the given path
169
- </p>
170
-
171
-
172
- </div>
173
- </div>
174
- <div class="tags">
175
- <h3>Parameters:</h3>
176
- <ul class="param">
177
-
178
- <li>
179
-
180
- <span class='type'>(<tt>String</tt>)</span>
181
-
182
-
183
- <span class='name'>the</span>
184
-
185
-
186
-
187
- &mdash;
188
- <div class='inline'><p>
189
- path (without wildcards) of the desired file relative to the gem root
190
- directory
191
- </p>
192
- </div>
193
-
194
- </li>
195
-
196
- </ul>
197
- <h3>Returns:</h3>
198
- <ul class="return">
199
-
200
- <li>
201
-
202
- <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
203
-
204
-
205
-
206
-
207
- &mdash;
208
- <div class='inline'><p>
209
- the file in this gem which matches the given path
210
- </p>
211
- </div>
212
-
213
- </li>
214
-
215
- </ul>
216
-
217
- </div><table class="source_code">
218
- <tr>
219
- <td>
220
- <pre class="lines">
221
-
222
-
223
- 5
224
- 6
225
- 7</pre>
226
- </td>
227
- <td>
228
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena.rb', line 5</span>
229
-
230
- <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='resource identifier id'>resource</span><span class='lparen token'>(</span><span class='path identifier id'>path</span><span class='rparen token'>)</span>
231
- <span class='File constant id'>File</span><span class='dot token'>.</span><span class='expand_path identifier id'>expand_path</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='dirname identifier id'>dirname</span><span class='lparen token'>(</span><span class='__FILE__ __file__ kw'>__FILE__</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='string val'>'..'</span><span class='comma token'>,</span> <span class='path identifier id'>path</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
232
- <span class='end end kw'>end</span>
233
- </pre>
234
- </td>
235
- </tr>
236
- </table>
237
- </div>
238
-
239
- <div class="method_details ">
240
- <p class="signature " id="seed-class_method">
122
+ <p class="signature first" id="seed-class_method">
241
123
 
242
124
  + (<tt>Object</tt>) <strong>seed</strong>
243
125
 
@@ -281,7 +163,7 @@ Creates the <span class='object_link'><a href="Galena/Seed/Defaults.html" title=
281
163
  </div>
282
164
 
283
165
  <div id="footer">
284
- Generated on Tue Nov 23 11:38:43 2010 by
166
+ Generated on Tue Nov 30 11:09:42 2010 by
285
167
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
286
168
  0.6.1 (ruby-1.8.6).
287
169
  </div>
@@ -194,7 +194,7 @@ the defaults instance
194
194
  </div>
195
195
 
196
196
  <div id="footer">
197
- Generated on Tue Nov 23 11:38:42 2010 by
197
+ Generated on Tue Nov 30 11:09:43 2010 by
198
198
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
199
199
  0.6.1 (ruby-1.8.6).
200
200
  </div>
@@ -102,7 +102,9 @@ secondary key rather than content, e.g.:
102
102
  </pre>
103
103
  <p>
104
104
  The complete definitions are included in this method for convenience in
105
- order to seed the example in a test database.
105
+ order to seed the example in a test database. A real-world migration might
106
+ find it useful to create a similar defaults file in order to rapidly seed
107
+ an empty test or staging database.
106
108
  </p>
107
109
 
108
110
 
@@ -343,13 +345,13 @@ Creates the Galena example Defaults singleton and populates the attributes.
343
345
  <pre class="lines">
344
346
 
345
347
 
346
- 33
347
348
  34
348
349
  35
349
- 36</pre>
350
+ 36
351
+ 37</pre>
350
352
  </td>
351
353
  <td>
352
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 33</span>
354
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 34</span>
353
355
 
354
356
  <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span>
355
357
  <span class='super super kw'>super</span>
@@ -393,12 +395,12 @@ Returns the value of attribute box_type
393
395
  <pre class="lines">
394
396
 
395
397
 
396
- 30
397
398
  31
398
- 32</pre>
399
+ 32
400
+ 33</pre>
399
401
  </td>
400
402
  <td>
401
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 30</span>
403
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 31</span>
402
404
 
403
405
  <span class='def def kw'>def</span> <span class='box_type identifier id'>box_type</span>
404
406
  <span class='@box_type ivar id'>@box_type</span>
@@ -436,12 +438,12 @@ Returns the value of attribute freezer_type
436
438
  <pre class="lines">
437
439
 
438
440
 
439
- 30
440
441
  31
441
- 32</pre>
442
+ 32
443
+ 33</pre>
442
444
  </td>
443
445
  <td>
444
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 30</span>
446
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 31</span>
445
447
 
446
448
  <span class='def def kw'>def</span> <span class='freezer_type identifier id'>freezer_type</span>
447
449
  <span class='@freezer_type ivar id'>@freezer_type</span>
@@ -479,12 +481,12 @@ Returns the value of attribute hospital
479
481
  <pre class="lines">
480
482
 
481
483
 
482
- 30
483
484
  31
484
- 32</pre>
485
+ 32
486
+ 33</pre>
485
487
  </td>
486
488
  <td>
487
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 30</span>
489
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 31</span>
488
490
 
489
491
  <span class='def def kw'>def</span> <span class='hospital identifier id'>hospital</span>
490
492
  <span class='@hospital ivar id'>@hospital</span>
@@ -522,12 +524,12 @@ Returns the value of attribute protocol
522
524
  <pre class="lines">
523
525
 
524
526
 
525
- 30
526
527
  31
527
- 32</pre>
528
+ 32
529
+ 33</pre>
528
530
  </td>
529
531
  <td>
530
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 30</span>
532
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 31</span>
531
533
 
532
534
  <span class='def def kw'>def</span> <span class='protocol identifier id'>protocol</span>
533
535
  <span class='@protocol ivar id'>@protocol</span>
@@ -565,12 +567,12 @@ Returns the value of attribute tissue_bank
565
567
  <pre class="lines">
566
568
 
567
569
 
568
- 30
569
570
  31
570
- 32</pre>
571
+ 32
572
+ 33</pre>
571
573
  </td>
572
574
  <td>
573
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 30</span>
575
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 31</span>
574
576
 
575
577
  <span class='def def kw'>def</span> <span class='tissue_bank identifier id'>tissue_bank</span>
576
578
  <span class='@tissue_bank ivar id'>@tissue_bank</span>
@@ -612,19 +614,21 @@ Creates the Galena example administrative objects as necessary.
612
614
  <pre class="lines">
613
615
 
614
616
 
615
- 39
616
617
  40
617
618
  41
618
619
  42
619
- 43</pre>
620
+ 43
621
+ 44
622
+ 45</pre>
620
623
  </td>
621
624
  <td>
622
- <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 39</span>
625
+ <pre class="code"><span class="info file"># File 'examples/galena/lib/galena/seed/defaults.rb', line 40</span>
623
626
 
624
627
  <span class='def def kw'>def</span> <span class='ensure_exists identifier id'>ensure_exists</span>
625
628
  <span class='@protocol ivar id'>@protocol</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='symbol val'>:create</span><span class='rparen token'>)</span>
626
629
  <span class='@hospital ivar id'>@hospital</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='symbol val'>:create</span><span class='rparen token'>)</span>
627
- <span class='@freezer_type ivar id'>@freezer_type</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='symbol val'>:create</span><span class='rparen token'>)</span>
630
+ <span class='@surgeon ivar id'>@surgeon</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='symbol val'>:create</span><span class='rparen token'>)</span>
631
+ <span class='@box ivar id'>@box</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='symbol val'>:create</span><span class='rparen token'>)</span>
628
632
  <span class='end end kw'>end</span>
629
633
  </pre>
630
634
  </td>
@@ -637,7 +641,7 @@ Creates the Galena example administrative objects as necessary.
637
641
  </div>
638
642
 
639
643
  <div id="footer">
640
- Generated on Tue Nov 23 11:38:43 2010 by
644
+ Generated on Tue Nov 30 11:09:43 2010 by
641
645
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
642
646
  0.6.1 (ruby-1.8.6).
643
647
  </div>
@@ -76,13 +76,6 @@
76
76
 
77
77
  </li>
78
78
 
79
- <li>
80
- <span class='object_link'><a href="CaTissue/CollectionProtocolRegistration.html" title="CaTissue::CollectionProtocolRegistration (class)">CollectionProtocolRegistration</a></span>
81
-
82
- <small>(CaTissue)</small>
83
-
84
- </li>
85
-
86
79
  </ul>
87
80
  </ul>
88
81
 
@@ -179,7 +172,7 @@
179
172
  </div></div>
180
173
 
181
174
  <div id="footer">
182
- Generated on Tue Nov 23 11:38:42 2010 by
175
+ Generated on Tue Nov 30 11:09:42 2010 by
183
176
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
184
177
  0.6.1 (ruby-1.8.6).
185
178
  </div>
@@ -27,7 +27,7 @@
27
27
 
28
28
  <ul id="full_list" class="class">
29
29
  <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
30
- <li><a class='toggle'></a> <span class='object_link'><a href="CaTissue.html" title="CaTissue (module)">CaTissue</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="CaTissue/CollectionProtocolRegistration.html" title="CaTissue::CollectionProtocolRegistration (class)">CollectionProtocolRegistration</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/Participant.html" title="CaTissue::Participant (class)">Participant</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/SpecimenCollectionGroup.html" title="CaTissue::SpecimenCollectionGroup (class)">SpecimenCollectionGroup</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/StorageContainer.html" title="CaTissue::StorageContainer (class)">StorageContainer</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/TissueSpecimen.html" title="CaTissue::TissueSpecimen (class)">TissueSpecimen</a></span> &lt; Object<small class='search_info'>CaTissue</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Galena.html" title="Galena (module)">Galena</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Galena/Seed.html" title="Galena::Seed (module)">Seed</a></span><small class='search_info'>Galena</small></li><ul><li><span class='object_link'><a href="Galena/Seed/Defaults.html" title="Galena::Seed::Defaults (class)">Defaults</a></span> &lt; Object<small class='search_info'>Galena::Seed</small></li></ul></ul>
30
+ <li><a class='toggle'></a> <span class='object_link'><a href="CaTissue.html" title="CaTissue (module)">CaTissue</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="CaTissue/Participant.html" title="CaTissue::Participant (class)">Participant</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/SpecimenCollectionGroup.html" title="CaTissue::SpecimenCollectionGroup (class)">SpecimenCollectionGroup</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/StorageContainer.html" title="CaTissue::StorageContainer (class)">StorageContainer</a></span> &lt; Object<small class='search_info'>CaTissue</small></li><li><span class='object_link'><a href="CaTissue/TissueSpecimen.html" title="CaTissue::TissueSpecimen (class)">TissueSpecimen</a></span> &lt; Object<small class='search_info'>CaTissue</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Galena.html" title="Galena (module)">Galena</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Galena/Seed.html" title="Galena::Seed (module)">Seed</a></span><small class='search_info'>Galena</small></li><ul><li><span class='object_link'><a href="Galena/Seed/Defaults.html" title="Galena::Seed::Defaults (class)">Defaults</a></span> &lt; Object<small class='search_info'>Galena::Seed</small></li></ul></ul>
31
31
 
32
32
  </ul>
33
33
  </div>
@@ -70,8 +70,8 @@ The use cases illustrate several common migration impediments:</p>
70
70
  <li><p>Copy the example into a location of your choosing.</p></li>
71
71
  <li><p>Configure a caTissue client to connect to a test caTissue instance, as described in the
72
72
  caTissue Technical Guide.</p></li>
73
- <li><p>Define the caRuby Tissue access property file as described in
74
- <a href="FAQ">http://caruby.tenderapp.com/faqs/getting-started/tissue_config</a>.</p></li>
73
+ <li><p>Define the caRuby Tissue access property file as described in the configuration
74
+ <a href="how-do-i-configure-caruby-to-work-with-catissue">FAQ</a>.</p></li>
75
75
  </ol>
76
76
 
77
77
 
@@ -90,16 +90,61 @@ For example, the <code>simple.csv</code> input file is migrated into caTissue us
90
90
  <li><p>Open a console in the copied Galena example location.</p></li>
91
91
  <li><p>Run the following:</p>
92
92
 
93
- <p> crtmigrate --file conf/migration/simple.yaml data/simple.yaml</p></li>
94
- <li><p>Check the test database and verify that a there is a collection protocol
95
- named `Galena CP.</p></li>
93
+ <p> bin/seed</p>
94
+
95
+ <p>This command initializes the administrative objects in the Galena test database,
96
+ including the Galena collection protocol, site, cancer center, tissue bank and coordinator.</p></li>
97
+ <li><p>Run the following:</p>
98
+
99
+ <p> crtmigrate --target TissueSpecimen --mapping conf/migration/simple_fields.yaml data/simple.csv</p>
100
+
101
+ <p>This command migrates the CSV record in the <code>simple.csv</code> input file into a caTissue
102
+ <code>TissueSpecimen</code> based on the <code>simple_fields.yaml</code> mapping file.
103
+ The command will take a couple of minutes to finish, since the less information
104
+ you provide caRuby the more it works to fill in the missing bits. In the meantime,
105
+ peruse the configuration and data files to see which data are migrated and
106
+ where this data ends up in caTissue.</p></li>
107
+ <li><p>Open the caTissue application on the test server and verify the content of the
108
+ Galena CP collection protocol.</p></li>
96
109
  </ol>
97
110
 
98
111
 
99
- <p>The other examples are run in a similar manner.</p></div></div>
112
+ <p>The other examples are run in a similar manner. Each example demonstrates different
113
+ features of the caRuby Migration utility as follows:</p>
114
+
115
+ <ul>
116
+ <li>simple - a good starting point with limited input fields</li>
117
+ <li>minimal - the fewest possible input fields without writing custom Ruby shim code</li>
118
+ <li>general - lots of input fields, no custom Ruby code</li>
119
+ <li>filter - a smattering of custom Ruby shim code to convert input values to caTissue values</li>
120
+ <li>frozen - an example demonstrating how to import storage locations</li>
121
+ </ul>
122
+
123
+
124
+ <p>Try running an example with the <code>--debug</code> flag and look at the <code>log/migration.log</code> file to see
125
+ what caRuby is up to behind the scenes (hint: a lot!).</p>
126
+
127
+ <h2>Input data</h2>
128
+
129
+ <p>The sample Galena Tissue Bank CSV input files hold one row for each specimen.
130
+ Common fields are as follows:</p>
131
+
132
+ <ul>
133
+ <li>MRN - Patient Medical Record Number</li>
134
+ <li>Initials - Patient name initials</li>
135
+ <li>Frozen? - Flag indicating whether the specimen is frozen</li>
136
+ <li>SPN - Surgical Pathology Number</li>
137
+ <li>Collection Date - Date the specimen was acquired by the tissue bank</li>
138
+ <li>Received Date - Date the specimen was donated by the participant</li>
139
+ <li>Quantity - Amount collected</li>
140
+ <li>Box - Tissue storage container</li>
141
+ <li>X - the tissue box column</li>
142
+ <li>Y - the tissue box row</li>
143
+ </ul>
144
+ </div></div>
100
145
 
101
146
  <div id="footer">
102
- Generated on Tue Nov 23 11:38:42 2010 by
147
+ Generated on Tue Nov 30 11:09:42 2010 by
103
148
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
104
149
  0.6.1 (ruby-1.8.6).
105
150
  </div>