[Bio] / Sprout / LoadSproutTables.pl Repository:
ViewVC logotype

Annotation of /Sprout/LoadSproutTables.pl

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (view) (download) (as text)

1 : parrello 1.1 #!/usr/bin/perl -w
2 :    
3 :     =head1 Load Sprout Tables
4 :    
5 : parrello 1.12 =head2 Introduction
6 :    
7 : parrello 1.14 The Sprout database reflects a snapshot of the SEED taken at a particular point in
8 :     time. At some point in the future, it will be possible to add annotations to the
9 :     Sprout data. All records added to Sprout after the snapshot is taken are
10 :     specially-marked so that the changes can be copied to the SEED. The SEED remains
11 :     the live version of the data.
12 :    
13 :     The snapshot is produced by reading the SEED data and writing it to sequential
14 :     files. There is one file per Sprout table, and each such file's name consists of
15 :     the table name with the suffix C<dtx>. Thus, the file for the C<Genome> table
16 :     would be named C<Genome.dtx>. These files are used to load the actual Sprout
17 :     database and to generate Glimpse indices.
18 :    
19 :     To load all the Sprout tables and then validate the result, you need to issue three
20 :     commands.
21 :    
22 :     LoadSproutTables -dbLoad -dbCreate "*"
23 : parrello 1.27 TestSproutLoad [genomeID] ...
24 :     index_sprout_lucene
25 :    
26 :     where I<[genomeID]> is one or more genome IDs. These genomes will be tested more
27 :     thoroughly than the others.
28 : parrello 1.14
29 :     All three commands send output to the console. In addition, C<LoadSproutTables> and
30 : parrello 1.27 C<TestSproutLoad> write tracing information to a trace log in the FIG temporary
31 : parrello 1.14 directory (B<$FIG_Config::Tmp>). At the bottom of the log file will be a complete
32 :     list of errors. If errors occur in C<LoadSproutTables>, then the data must be corrected
33 :     and the offending table group reloaded. So, for example, if there are errors in the
34 :     load of the B<MadeAnnotation> and B<Compound> tables, you would need to run
35 :    
36 :     LoadSproutTables -dbLoad Annotation Reaction
37 :    
38 :     because B<MadeAnnotation> is in the C<Annotation> group, and B<Compound> is in the
39 :     C<Reaction> group. A list of the groups is given below.
40 :    
41 :     You can omit the C<dbLoad> option to create the load files without
42 :     loading the database, and you can add a C<trace> option to change the trace level.
43 :     The command below creates the Genome-related load files with a trace level of 3 and
44 :     does not load them into the Sprout database.
45 :    
46 :     LoadSproutTables -trace=3 Genome
47 :    
48 :     C<LoadSproutTables> takes a long time to run, so setting the trace level to 3 helps
49 :     to give you an idea of the progress.
50 :    
51 : parrello 1.28 =head2 The NMPDR Web Site
52 :    
53 :     Sprout is the database engine for the NMPDR web site. The NMPDR web site consists of two
54 :     pieces that run on two different machines. The B<WEB> machine contains HTML pages
55 :     generated by a Content Management Tool.
56 :    
57 : parrello 1.14 =head2 Procedure For Loading Sprout
58 :    
59 : parrello 1.27 In order to load the Sprout, you need to have the B<Sprout>, B<NmpdrConfigs>, and
60 :     B<LuceneSearch> projects checked out from CVS in addition to the standard FIG
61 :     projects. You must also set up the following B<FIG_Config.pm> variables in addition
62 :     to the normal ones.
63 :    
64 :     =over 4
65 :    
66 :     =item sproutData
67 :    
68 :     Name of the data directory for the Sprout load files.
69 :    
70 :     =item var
71 :    
72 :     Name of the directory to contain cached NMPDR pages. The most important file in
73 :     this directory is C<nmpdr_page_template.html>, which contains a skeleton page
74 :     from the main NMPDR web site. This skeleton page is used to generate output
75 :     pages that look like the other NMPDR pages.
76 :    
77 :     =item java
78 :    
79 :     Path to the Java runtime environment.
80 :    
81 :     =item sproutDB
82 :    
83 :     Name of the Sprout database
84 :    
85 :     =item dbuser
86 :    
87 :     User name for logging into the Sprout database.
88 :    
89 :     =item dbpass
90 :    
91 :     Password for logging into the Sprout database.
92 :    
93 :     =item nmpdr_site_url
94 :    
95 :     URL for the NMPDR cover pages. The NMPDR cover pages are informational and text
96 :     pages that serve as the entry point to the NMPDR web site. They are generated by
97 :     a Content Management tool, and some Sprout scripts need to know where to find
98 :     them.
99 :    
100 :     =item nmpdr_site_template_id
101 :    
102 :     Page number for the template page used to generate results that look like they're
103 :     part of the NMPDR web site.
104 :    
105 :     =back
106 :    
107 : parrello 1.39 Most of the above preparation is performed by the B<NMPDRSetup> utility.
108 :     NMPDRSetup prints the instructions for completing the process, including
109 :     loading the Sprout database. The specific procedure for loading
110 :     the Sprout data, however, is as follows.
111 : parrello 1.27
112 : parrello 1.14 =head2 LoadSproutTables Command
113 :    
114 :     C<LoadSproutTables> creates the load files for Sprout tables and optionally loads them.
115 : parrello 1.12 The parameters are the names of the table groups whose data is to be created.
116 :     The legal table group names are given below.
117 : parrello 1.1
118 :     =over 4
119 :    
120 :     =item Genome
121 :    
122 :     Loads B<Genome>, B<HasContig>, B<Contig>, B<IsMadeUpOf>, and B<Sequence>.
123 :    
124 : parrello 1.30 =item Feature
125 :    
126 :     Loads B<Feature>, B<FeatureAlias>, B<FeatureTranslation>, B<FeatureUpstream>,
127 : parrello 1.44 B<IsLocatedIn>, B<FeatureLink>, B<IsAliasOf>, B<CDD>, B<HasFeature>,
128 :     B<HasRoleInSubsystem>, B<FeatureEssential>, B<FeatureVirulent>, B<FeatureIEDB>,
129 :     B<CDD>, and B<IsPresentOnProteinOf>
130 : parrello 1.1
131 :     =item Subsystem
132 :    
133 : parrello 1.2 Loads B<Subsystem>, B<Role>, B<SSCell>, B<ContainsFeature>, B<IsGenomeOf>,
134 : parrello 1.8 B<IsRoleOf>, B<OccursInSubsystem>, B<ParticipatesIn>, B<HasSSCell>,
135 : parrello 1.48 B<ConsistsOfRoles>, B<RoleSubset>, B<HasRoleSubset>,
136 : parrello 1.13 B<ConsistsOfGenomes>, B<GenomeSubset>, B<HasGenomeSubset>, B<Diagram>,
137 : parrello 1.48 B<RoleOccursIn>, B<SubSystemClass>, B<RoleEC>, B<IsIdentifiedByEC>, and
138 : parrello 1.44 B<ContainsFeature>.
139 : parrello 1.1
140 : parrello 1.2 =item Annotation
141 :    
142 : parrello 1.48 Loads B<SproutUser>, B<UserAccess>, B<Annotation>, B<IsTargetOfAnnotation>, and
143 : parrello 1.2 B<MadeAnnotation>.
144 :    
145 :     =item Property
146 :    
147 : parrello 1.48 Loads B<Property>, and B<HasProperty>.
148 : parrello 1.2
149 : parrello 1.3 =item Group
150 :    
151 :     Loads B<GenomeGroups>.
152 :    
153 :     =item Source
154 :    
155 : parrello 1.48 Loads B<Source>, B<ComesFrom>, and B<SourceURL>.
156 : parrello 1.4
157 : parrello 1.8 =item Reaction
158 :    
159 :     Loads B<ReactionURL>, B<Compound>, B<CompoundName>,
160 : parrello 1.48 B<CompoundCAS>, B<IsAComponentOf>, B<Reaction>, B<Scenario>, B<IsInputFor>,
161 :     B<IsOutputOf>, B<IsOnDiagram>, and B<Catalyzes>.
162 : parrello 1.8
163 : parrello 1.31 =item Synonym
164 :    
165 :     Loads B<SynonymGroup> and B<IsSynonymGroupFor>.
166 :    
167 : parrello 1.36 =item Family
168 :    
169 : parrello 1.38 Loads B<Family> and B<IsFamilyForFeature>.
170 : parrello 1.36
171 : parrello 1.41 =item Drug
172 :    
173 : parrello 1.44 Loads B<PDB>, B<DocksWith>, C<IsProteinForFeature>, and C<Ligand>.
174 : parrello 1.41
175 : parrello 1.3 =item *
176 :    
177 :     Loads all of the above tables.
178 :    
179 : parrello 1.1 =back
180 :    
181 : parrello 1.7 The command-line options are given below.
182 : parrello 1.1
183 :     =over 4
184 :    
185 :     =item geneFile
186 :    
187 :     The name of the file containing the genomes and their associated access codes. The
188 :     file should have one line per genome, each line consisting of the genome ID followed
189 :     by the access code, separated by a tab. If no file is specified, all complete genomes
190 : parrello 1.39 will be processed and the access code will be 1. Specify C<default> to use the
191 :     default gene file-- C<genes.tbl> in the C<SproutData> directory.
192 : parrello 1.1
193 :     =item subsysFile
194 :    
195 :     The name of the file containing the trusted subsystems. The file should have one line
196 :     per trusted subsystem. If no file is specified, all subsystems will be trusted.
197 :    
198 :     =item trace
199 :    
200 :     Desired tracing level. The default is 3.
201 :    
202 : parrello 1.25 =item user
203 :    
204 : parrello 1.35 Suffix to use for trace, output, and error files created.
205 : parrello 1.25
206 : parrello 1.10 =item dbLoad
207 :    
208 :     If TRUE, the database tables will be loaded automatically from the load files created.
209 :    
210 : parrello 1.14 =item dbCreate
211 : parrello 1.1
212 : parrello 1.14 If TRUE, the database will be created. If the database exists already, it will be
213 :     dropped. Use the function with caution.
214 : parrello 1.12
215 : parrello 1.17 =item loadOnly
216 :    
217 :     If TRUE, the database tables will be loaded from existing load files. Load files
218 :     will not be created. This option is useful if you are setting up a copy of Sprout
219 :     and have load files already set up from the original version.
220 :    
221 : parrello 1.25 =item background
222 :    
223 :     Redirect the standard and error output to files in the FIG temporary directory.
224 :    
225 :     =item resume
226 :    
227 :     Resume an interrupted load, starting with the load group specified in the first
228 :     positional parameter.
229 :    
230 :     =item sql
231 :    
232 :     Trace SQL statements.
233 :    
234 : parrello 1.32 =item phone
235 :    
236 :     Phone number to message when the load finishes.
237 :    
238 : parrello 1.14 =back
239 : parrello 1.12
240 : parrello 1.1 =cut
241 :    
242 :     use strict;
243 :     use Tracer;
244 :     use Cwd;
245 :     use FIG;
246 :     use SFXlate;
247 :     use File::Copy;
248 :     use File::Path;
249 :     use SproutLoad;
250 :     use Stats;
251 : parrello 1.9 use SFXlate;
252 : parrello 1.1
253 : parrello 1.44 # This is a list of the load groups in their natural order. We'll go through these in sequence, processing
254 :     # the ones the user asks for.
255 : parrello 1.48 my @LoadGroups = qw(Genome Subsystem Property Annotation Source Reaction Synonym Family Drug Feature);
256 : parrello 1.44
257 : parrello 1.1 # Get the command-line parameters and options.
258 : parrello 1.17 my ($options, @parameters) = StandardSetup(['SproutLoad', 'ERDBLoad', 'Stats',
259 : parrello 1.26 'ERDB', 'Load', 'Sprout', 'Subsystem'],
260 : parrello 1.18 { geneFile => ["", "name of the genome list file"],
261 :     subsysFile => ["", "name of the trusted subsystem file"],
262 :     dbLoad => [0, "load the database from generated files"],
263 :     dbCreate => [0, "drop and re-create the database"],
264 : parrello 1.19 loadOnly => [0, "load the database from previously generated files"],
265 : parrello 1.23 resume => [0, "resume a complete load starting with the first group specified in the parameter list"],
266 : parrello 1.32 phone => ["", "phone number (international format) to call when load finishes"],
267 : parrello 1.18 },
268 :     "<group1> <group2> ...",
269 : parrello 1.17 @ARGV);
270 :     # If we're doing a load-only, turn on loading.
271 :     if ($options->{loadOnly}) {
272 :     $options->{dbLoad} = 1
273 :     }
274 : parrello 1.14 if ($options->{dbCreate}) {
275 :     # Here we want to drop and re-create the database.
276 :     my $db = $FIG_Config::sproutDB;
277 : parrello 1.20 DBKernel::CreateDB($db);
278 : parrello 1.14 }
279 : parrello 1.39 # Compute the gene file name.
280 :     my $geneFile = $options->{geneFile};
281 :     if ($geneFile eq 'default') {
282 :     $geneFile = "$FIG_Config::sproutData/genes.tbl";
283 :     }
284 : parrello 1.9 # Create the sprout loader object. Note that the Sprout object does not
285 : parrello 1.10 # open the database unless the "dbLoad" option is turned on.
286 : parrello 1.1 my $fig = FIG->new();
287 : parrello 1.10 my $sprout = SFXlate->new_sprout_only(undef, undef, undef, ! $options->{dbLoad});
288 : parrello 1.39 my $spl = SproutLoad->new($sprout, $fig, $geneFile, $options->{subsysFile}, $options);
289 : parrello 1.15 # Insure we have an output directory.
290 :     FIG::verify_dir($FIG_Config::sproutData);
291 : parrello 1.46 # Check for the "*" option.
292 :     if ($parameters[0] eq '*') {
293 :     @parameters = @LoadGroups;
294 :     }
295 : parrello 1.23 # If we're resuming, we only want to have 1 parameter.
296 :     my $resume = $options->{resume};
297 :     if ($resume && @parameters > 1) {
298 :     Confess("If resume=1, only one load group can be specified.");
299 :     } elsif (! @parameters) {
300 : parrello 1.34 Trace("No load groups were specified.") if T(0);
301 : parrello 1.23 }
302 : parrello 1.44 # Process the resume option here. We modify the incoming parameters to
303 :     # contain the resume group and everything after it.
304 :     if ($resume) {
305 :     # Save the starting group.
306 :     my $resumeGroup = $parameters[0];
307 :     # Copy the load group list into the parameter array.
308 :     @parameters = @LoadGroups;
309 :     # Shift out the groups until we reach our desired starting point.
310 :     while (scalar(@parameters) && $parameters[0] ne $resumeGroup) {
311 :     shift @parameters;
312 :     }
313 :     if (! @parameters) {
314 :     Confess("Resume group \"$resumeGroup\" not found.");
315 :     }
316 :     }
317 : parrello 1.32 # Set a variable to contain return type information.
318 :     my $rtype;
319 : parrello 1.44 # Set up a statistics object for statistics about the entire load.
320 :     my $totalStats = Stats->new();
321 : parrello 1.32 # Insure we catch errors.
322 :     eval {
323 :     # Process the parameters.
324 :     for my $group (@parameters) {
325 :     Trace("Processing load group $group.") if T(2);
326 : parrello 1.44 # Compute the string we want to execute.
327 :     my $code = "\$spl->Load${group}Data()";
328 :     # Load this group.
329 :     my $stats = eval($code);
330 : parrello 1.45 if ($@) {
331 :     Confess("Load group error: $@");
332 :     }
333 : parrello 1.44 # Merge the statistics into the master.
334 :     $totalStats->Accumulate($stats);
335 :     }
336 :     # Compute the statistical display.
337 :     my $statDisplay = $totalStats->Show();
338 :     # Display it.
339 :     Trace("Statistics for this load:\n$statDisplay") if T(2);
340 :     # Check for a "table load failed" message. If we find one, we want
341 :     # to end with an error.
342 :     if ($statDisplay =~ /table load failed/i) {
343 :     Confess("One or more table loads failed.");
344 : parrello 1.32 }
345 :     };
346 :     if ($@) {
347 :     Trace("Load failed with error: $@") if T(0);
348 :     $rtype = "error";
349 :     } else {
350 :     Trace("Load complete.") if T(2);
351 :     $rtype = "no error";
352 :     }
353 : parrello 1.33 if ($options->{phone}) {
354 : parrello 1.32 my $msgID = Tracer::SendSMS($options->{phone}, "Sprout load terminated with $rtype.");
355 :     if ($msgID) {
356 :     Trace("Phone message sent with ID $msgID.") if T(2);
357 :     } else {
358 :     Trace("Phone message not sent.") if T(2);
359 : parrello 1.31 }
360 : parrello 1.1 }
361 : parrello 1.35
362 : parrello 1.1 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3