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

Diff of /Sprout/LoadSproutTables.pl

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4, Sun Sep 11 17:06:21 2005 UTC revision 1.48, Tue Sep 9 21:02:10 2008 UTC
# Line 2  Line 2 
2    
3  =head1 Load Sprout Tables  =head1 Load Sprout Tables
4    
5  Create the load files for a group of Sprout tables. The parameters are the names of  =head2 Introduction
6  the table groups whose data is to be created. The legal table group names are given below.  
7    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        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    
29    All three commands send output to the console. In addition, C<LoadSproutTables> and
30    C<TestSproutLoad> write tracing information to a trace log in the FIG temporary
31    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    =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    =head2 Procedure For Loading Sprout
58    
59    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  =over 4
65    
66  =item Genome  =item sproutData
67    
68  Loads B<Genome>, B<HasContig>, B<Contig>, B<IsMadeUpOf>, and B<Sequence>.  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  =item Coupling  Path to the Java runtime environment.
80    
81  Loads B<Coupling>, B<IsEvidencedBy>, B<PCH>, B<ParticipatesInCoupling>,  =item sproutDB
82  B<UsesAsEvidence>.  
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    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    
112    =head2 LoadSproutTables Command
113    
114    C<LoadSproutTables> creates the load files for Sprout tables and optionally loads them.
115    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    
118    =over 4
119    
120    =item Genome
121    
122    Loads B<Genome>, B<HasContig>, B<Contig>, B<IsMadeUpOf>, and B<Sequence>.
123    
124  =item Feature  =item Feature
125    
126  Loads B<Feature>, B<FeatureAlias>, B<FeatureTranslation>, B<FeatureUpstream>,  Loads B<Feature>, B<FeatureAlias>, B<FeatureTranslation>, B<FeatureUpstream>,
127  B<IsLocatedIn>, B<FeatureLink>.  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    
131  =item Subsystem  =item Subsystem
132    
133  Loads B<Subsystem>, B<Role>, B<SSCell>, B<ContainsFeature>, B<IsGenomeOf>,  Loads B<Subsystem>, B<Role>, B<SSCell>, B<ContainsFeature>, B<IsGenomeOf>,
134  B<IsRoleOf>, B<OccursInSubsystem>, B<ParticipatesIn>, B<HasSSCell>.  B<IsRoleOf>, B<OccursInSubsystem>, B<ParticipatesIn>, B<HasSSCell>,
135    B<ConsistsOfRoles>, B<RoleSubset>, B<HasRoleSubset>,
136    B<ConsistsOfGenomes>, B<GenomeSubset>, B<HasGenomeSubset>, B<Diagram>,
137    B<RoleOccursIn>, B<SubSystemClass>, B<RoleEC>, B<IsIdentifiedByEC>, and
138    B<ContainsFeature>.
139    
140  =item Annotation  =item Annotation
141    
142  Loads B<SproutUser>, B<UserAccess>, B<Annotation>, B<IsTargetOfAnnotation>,  Loads B<SproutUser>, B<UserAccess>, B<Annotation>, B<IsTargetOfAnnotation>, and
143  B<MadeAnnotation>.  B<MadeAnnotation>.
144    
 =item Diagram  
   
 Loads B<Diagram>, B<RoleOccursIn>.  
   
145  =item Property  =item Property
146    
147  Loads B<Property>, B<HasProperty>.  Loads B<Property>, and B<HasProperty>.
   
 =item BBH  
   
 Loads B<IsBidirectionalBestHitOf>.  
148    
149  =item Group  =item Group
150    
# Line 49  Line 152 
152    
153  =item Source  =item Source
154    
155  Loads B<Source>, B<ComesFrom>, B<SourceURL>.  Loads B<Source>, B<ComesFrom>, and B<SourceURL>.
156    
157    =item Reaction
158    
159    Loads B<ReactionURL>, B<Compound>, B<CompoundName>,
160    B<CompoundCAS>, B<IsAComponentOf>, B<Reaction>, B<Scenario>, B<IsInputFor>,
161    B<IsOutputOf>, B<IsOnDiagram>, and B<Catalyzes>.
162    
163    =item Synonym
164    
165  =item External  Loads B<SynonymGroup> and B<IsSynonymGroupFor>.
166    
167  Loads B<ExternalAliasOrg>, B<ExternalAliasFunc>.  =item Family
168    
169    Loads B<Family> and B<IsFamilyForFeature>.
170    
171    =item Drug
172    
173    Loads B<PDB>, B<DocksWith>, C<IsProteinForFeature>, and C<Ligand>.
174    
175  =item *  =item *
176    
# Line 61  Line 178 
178    
179  =back  =back
180    
181  There are two command-line options, given below. Note that in the command line, spaces  The command-line options are given below.
 inside parameters should be represented by C<\b>.  
182    
183  =over 4  =over 4
184    
# Line 71  Line 187 
187  The name of the file containing the genomes and their associated access codes. The  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  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  by the access code, separated by a tab. If no file is specified, all complete genomes
190  will be processed and the access code will be 1.  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    
193  =item subsysFile  =item subsysFile
194    
# Line 82  Line 199 
199    
200  Desired tracing level. The default is 3.  Desired tracing level. The default is 3.
201    
202    =item user
203    
204    Suffix to use for trace, output, and error files created.
205    
206    =item dbLoad
207    
208    If TRUE, the database tables will be loaded automatically from the load files created.
209    
210    =item dbCreate
211    
212    If TRUE, the database will be created. If the database exists already, it will be
213    dropped. Use the function with caution.
214    
215    =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    =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    =item phone
235    
236    Phone number to message when the load finishes.
237    
238  =back  =back
239    
240  =cut  =cut
241    
242  use strict;  use strict;
243  use Tracer;  use Tracer;
 use DocUtils;  
244  use Cwd;  use Cwd;
245  use FIG;  use FIG;
246  use SFXlate;  use SFXlate;
# Line 96  Line 248 
248  use File::Path;  use File::Path;
249  use SproutLoad;  use SproutLoad;
250  use Stats;  use Stats;
251    use SFXlate;
252    
253    # 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    my @LoadGroups = qw(Genome Subsystem Property Annotation Source Reaction Synonym Family Drug Feature);
256    
257  # Get the command-line parameters and options.  # Get the command-line parameters and options.
258  my ($options, @parameters) = Tracer::ParseCommand({ geneFile => "", subsysFile => "",  my ($options, @parameters) = StandardSetup(['SproutLoad', 'ERDBLoad', 'Stats',
259                                                      trace => 3 },                                              'ERDB', 'Load', 'Sprout', 'Subsystem'],
260                                                { 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                                                  loadOnly => [0, "load the database from previously generated files"],
265                                                  resume => [0, "resume a complete load starting with the first group specified in the parameter list"],
266                                                  phone => ["", "phone number (international format) to call when load finishes"],
267                                                },
268                                                "<group1> <group2> ...",
269                                                                 @ARGV);                                                                 @ARGV);
270  # Set up tracing.  # If we're doing a load-only, turn on loading.
271  TSetup("$options->{trace} SproutLoad ERDBLoad ERDB Stats Tracer Load", "+>$FIG_Config::temp/trace.log");  if ($options->{loadOnly}) {
272  # Create the sprout loader object.      $options->{dbLoad} = 1
273    }
274    if ($options->{dbCreate}) {
275        # Here we want to drop and re-create the database.
276        my $db = $FIG_Config::sproutDB;
277        DBKernel::CreateDB($db);
278    }
279    # Compute the gene file name.
280    my $geneFile = $options->{geneFile};
281    if ($geneFile eq 'default') {
282        $geneFile = "$FIG_Config::sproutData/genes.tbl";
283    }
284    # Create the sprout loader object. Note that the Sprout object does not
285    # open the database unless the "dbLoad" option is turned on.
286  my $fig = FIG->new();  my $fig = FIG->new();
287  my $sprout = SFXlate->new_sprout_only();  my $sprout = SFXlate->new_sprout_only(undef, undef, undef, ! $options->{dbLoad});
288  my $spl = SproutLoad->new($sprout, $fig, $options->{geneFile},  my $spl = SproutLoad->new($sprout, $fig, $geneFile, $options->{subsysFile}, $options);
289                            $options->{subsysFile});  # Insure we have an output directory.
290    FIG::verify_dir($FIG_Config::sproutData);
291    # Check for the "*" option.
292    if ($parameters[0] eq '*') {
293        @parameters = @LoadGroups;
294    }
295    # 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        Trace("No load groups were specified.") if T(0);
301    }
302    # 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    # Set a variable to contain return type information.
318    my $rtype;
319    # Set up a statistics object for statistics about the entire load.
320    my $totalStats = Stats->new();
321    # Insure we catch errors.
322    eval {
323  # Process the parameters.  # Process the parameters.
324  for my $group (@parameters) {  for my $group (@parameters) {
325      Trace("Processing load group $group.") if T(2);      Trace("Processing load group $group.") if T(2);
326      my $stats;          # Compute the string we want to execute.
327      if ($group eq 'Genome' || $group eq '*') {          my $code = "\$spl->Load${group}Data()";
328          $spl->LoadGenomeData();          # Load this group.
329      }          my $stats = eval($code);
330      if ($group eq 'Feature' || $group eq '*') {          if ($@) {
331          $spl->LoadFeatureData();              Confess("Load group error: $@");
332      }          }
333      if ($group eq 'Coupling' || $group eq '*') {          # Merge the statistics into the master.
334          $spl->LoadCouplingData();          $totalStats->Accumulate($stats);
335      }      }
336      if ($group eq 'Subsystem' || $group eq '*') {      # Compute the statistical display.
337          $spl->LoadSubsystemData();      my $statDisplay = $totalStats->Show();
338      }      # Display it.
339      if ($group eq 'Property' || $group eq '*') {      Trace("Statistics for this load:\n$statDisplay") if T(2);
340          $spl->LoadPropertyData();      # Check for a "table load failed" message. If we find one, we want
341      }      # to end with an error.
342      if ($group eq 'Diagram' || $group eq '*') {      if ($statDisplay =~ /table load failed/i) {
343          $spl->LoadDiagramData();          Confess("One or more table loads failed.");
344      }      }
345      if ($group eq 'Annotation' || $group eq '*') {  };
346          $spl->LoadAnnotationData();  if ($@) {
347      }      Trace("Load failed with error: $@") if T(0);
348      if ($group eq 'BBH' || $group eq '*') {      $rtype = "error";
349          $spl->LoadBBHData();  } else {
350      }      Trace("Load complete.") if T(2);
351      if ($group eq 'Group' || $group eq '*') {      $rtype = "no error";
         $spl->LoadGroupData();  
     }  
     if ($group eq 'Source' || $group eq '*') {  
         $spl->LoadSourceData();  
352      }      }
353      if ($group eq 'External' || $group eq '*') {  if ($options->{phone}) {
354          $spl->LoadExternalData();      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      }      }
   
360  }  }
 Trace("Load complete.") if T(2);  
361    
362  1;  1;

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.48

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3