[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.1, Wed Jul 27 20:05:24 2005 UTC revision 1.20, Tue Jan 31 07:33:46 2006 UTC
# Line 2  Line 2 
2    
3  =head1 Load Sprout Tables  =head1 Load Sprout Tables
4    
5  Load a group of Sprout tables from the command line. The parameters are the names of  =head2 Introduction
6  the table groups to load. 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
24        index_sprout
25    
26    All three commands send output to the console. In addition, C<LoadSproutTables> and
27    C<TestSproutLoad> write tracing information to C<trace.log> in the FIG temporary
28    directory (B<$FIG_Config::Tmp>). At the bottom of the log file will be a complete
29    list of errors. If errors occur in C<LoadSproutTables>, then the data must be corrected
30    and the offending table group reloaded. So, for example, if there are errors in the
31    load of the B<MadeAnnotation> and B<Compound> tables, you would need to run
32    
33        LoadSproutTables -dbLoad Annotation Reaction
34    
35    because B<MadeAnnotation> is in the C<Annotation> group, and B<Compound> is in the
36    C<Reaction> group. A list of the groups is given below.
37    
38    You can omit the C<dbLoad> option to create the load files without
39    loading the database, and you can add a C<trace> option to change the trace level.
40    The command below creates the Genome-related load files with a trace level of 3 and
41    does not load them into the Sprout database.
42    
43        LoadSproutTables -trace=3 Genome
44    
45    C<LoadSproutTables> takes a long time to run, so setting the trace level to 3 helps
46    to give you an idea of the progress.
47    
48    Once the Sprout database is loaded, B<TestSproutLoad> can be used to verify the load
49    against the FIG data. Again, the end of the C<trace.log> file will contain a summary
50    of the errors found. Like C<LoadSproutTables>, C<TestSproutLoad> is a time-consuming
51    script, so you may want to set the trace level to 3 to see visible progress.
52    
53        TestSproutLoad -trace=3
54    
55    Unlike C<LoadSproutTables>, in C<TestSproutLoad>, the individual errors found are
56    mixed in with the trace messages. They are all, however, marked with a trace type
57    of B<Problem>, as shown in the fragment below.
58    
59        11/02/2005 19:15:16 <main>: Processing feature fig|100226.1.peg.7742.
60        11/02/2005 19:15:17 <main>: Processing feature fig|100226.1.peg.7741.
61        11/02/2005 19:15:17 <Problem>: assignment "Short-chain dehydrodenase ...
62        11/02/2005 19:15:17 <Problem>: assignment "putative oxidoreductase." ...
63        11/02/2005 19:15:17 <Problem>: Incorrect assignment for fig|100226.1.peg.7741...
64        11/02/2005 19:15:17 <Problem>: Incorrect number of annotations found in ...
65        11/02/2005 19:15:17 <main>: Processing feature fig|100226.1.peg.7740.
66        11/02/2005 19:15:18 <main>: Processing feature fig|100226.1.peg.7739.
67    
68    The test may reveal that some tables need to be reloaded, or that a software
69    problem has crept into the Sprout.
70    
71    Once all the tables have the correct data, C<index_sprout> can be run to create the
72    Glimpse indexes.
73    
74    =head2 Procedure For Loading Sprout
75    
76    =over 4
77    
78    =item 1
79    
80    Type C<LoadSproutTables -dbLoad -dbCreate "*"> and press ENTER. This will create
81    the C<dtx> files and load them.
82    
83    =item 2
84    
85    Type C<TestSproutLoad 100226.1 83333.1> and press ENTER. This will validate
86    the Sprout database against the SEED data.
87    
88    =item 3
89    
90    If any errors are detected in step (2), it is most likely due to a change in
91    SEED that did not make it to Sprout. Contact Bruce Parrello or Robert Olson
92    to get the code updated properly.
93    
94    =item 4
95    
96    Type C<index_sprout> and press ENTER. This will create the Glimpse indexes
97    for the Sprout data.
98    
99    =back
100    
101    =head2 LoadSproutTables Command
102    
103    C<LoadSproutTables> creates the load files for Sprout tables and optionally loads them.
104    The parameters are the names of the table groups whose data is to be created.
105    The legal table group names are given below.
106    
107  =over 4  =over 4
108    
# Line 19  Line 118 
118  =item Feature  =item Feature
119    
120  Loads B<Feature>, B<FeatureAlias>, B<FeatureTranslation>, B<FeatureUpstream>,  Loads B<Feature>, B<FeatureAlias>, B<FeatureTranslation>, B<FeatureUpstream>,
121  B<IsLocatedIn>, B<IsBidirectionalBestHitOf>, B<FeatureLink>.  B<IsLocatedIn>, B<FeatureLink>.
122    
123  =item Subsystem  =item Subsystem
124    
125  Loads B<Subsystem>, B<Role>, B<SSCell>, B<Diagram>, B<ContainsFeature>, B<IsGenomeOf>,  Loads B<Subsystem>, B<Role>, B<SSCell>, B<ContainsFeature>, B<IsGenomeOf>,
126  B<IsRoleOf>, B<OccursInSubsystem>, B<ParticipatesIn>, B<HasSSCell>.  B<IsRoleOf>, B<OccursInSubsystem>, B<ParticipatesIn>, B<HasSSCell>,
127    B<Catalyzes>, B<ConsistsOfRoles>, B<RoleSubset>, B<HasRoleSubset>,
128    B<ConsistsOfGenomes>, B<GenomeSubset>, B<HasGenomeSubset>, B<Diagram>,
129    B<RoleOccursIn>.
130    
131    =item Annotation
132    
133    Loads B<SproutUser>, B<UserAccess>, B<Annotation>, B<IsTargetOfAnnotation>,
134    B<MadeAnnotation>.
135    
136    =item Property
137    
138    Loads B<Property>, B<HasProperty>.
139    
140    =item BBH
141    
142    Loads B<IsBidirectionalBestHitOf>.
143    
144    =item Group
145    
146    Loads B<GenomeGroups>.
147    
148    =item Source
149    
150    Loads B<Source>, B<ComesFrom>, B<SourceURL>.
151    
152    =item External
153    
154    Loads B<ExternalAliasOrg>, B<ExternalAliasFunc>.
155    
156    =item Reaction
157    
158    Loads B<ReactionURL>, B<Compound>, B<CompoundName>,
159    B<CompoundCAS>, B<IsAComponentOf>, B<Reaction>.
160    
161    =item *
162    
163    Loads all of the above tables.
164    
165  =back  =back
166    
167  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>.  
168    
169  =over 4  =over 4
170    
# Line 49  Line 184 
184    
185  Desired tracing level. The default is 3.  Desired tracing level. The default is 3.
186    
187    =item dbLoad
188    
189    If TRUE, the database tables will be loaded automatically from the load files created.
190    
191    =item dbCreate
192    
193    If TRUE, the database will be created. If the database exists already, it will be
194    dropped. Use the function with caution.
195    
196    =item loadOnly
197    
198    If TRUE, the database tables will be loaded from existing load files. Load files
199    will not be created. This option is useful if you are setting up a copy of Sprout
200    and have load files already set up from the original version.
201    
202    =item primaryOnly
203    
204    If TRUE, only the group's primary entity will be loaded.
205    
206  =back  =back
207    
208  =cut  =cut
# Line 56  Line 210 
210  use strict;  use strict;
211  use Tracer;  use Tracer;
212  use DocUtils;  use DocUtils;
 use TestUtils;  
213  use Cwd;  use Cwd;
214  use FIG;  use FIG;
215  use SFXlate;  use SFXlate;
# Line 64  Line 217 
217  use File::Path;  use File::Path;
218  use SproutLoad;  use SproutLoad;
219  use Stats;  use Stats;
220    use SFXlate;
221    
222  # Get the command-line parameters and options.  # Get the command-line parameters and options.
223  my ($options, @parameters) = Tracer::ParseCommand({ geneFile => "", subsysFile => "",  my ($options, @parameters) = StandardSetup(['SproutLoad', 'ERDBLoad', 'Stats',
224                                                      trace => 3 },                                              'ERDB', 'Load'],
225                                                { geneFile => ["", "name of the genome list file"],
226                                                  subsysFile => ["", "name of the trusted subsystem file"],
227                                                  dbLoad => [0, "load the database from generated files"],
228                                                  dbCreate => [0, "drop and re-create the database"],
229                                                  loadOnly => [0, "load the database from previously generated files"],
230                                                  primaryOnly => [0, "only process the group's main entity"]
231                                                },
232                                                "<group1> <group2> ...",
233                                                                 @ARGV);                                                                 @ARGV);
234  # Set up tracing.  # If we're doing a load-only, turn on loading.
235  TSetup("$options->{trace} SproutLoad ERDBLoad ERDB Tracer Load", "+>$FIG_Config::temp/trace.log");  if ($options->{loadOnly}) {
236  # Create the sprout loader object.      $options->{dbLoad} = 1
237    }
238    if ($options->{dbCreate}) {
239        # Here we want to drop and re-create the database.
240        my $db = $FIG_Config::sproutDB;
241        DBKernel::CreateDB($db);
242    }
243    # Create the sprout loader object. Note that the Sprout object does not
244    # open the database unless the "dbLoad" option is turned on.
245  my $fig = FIG->new();  my $fig = FIG->new();
246  my $sprout = SFXlate->new_sprout_only();  my $sprout = SFXlate->new_sprout_only(undef, undef, undef, ! $options->{dbLoad});
247  my $spl = SproutLoad->new($sprout, $fig, $options->{geneFile},  my $spl = SproutLoad->new($sprout, $fig, $options->{geneFile}, $options->{subsysFile}, $options);
248                            $options->{subsysFile});  # Insure we have an output directory.
249    FIG::verify_dir($FIG_Config::sproutData);
250  # Process the parameters.  # Process the parameters.
251  for my $group (@parameters) {  for my $group (@parameters) {
252      Trace("Processing load group $group.") if T(2);      Trace("Processing load group $group.") if T(2);
253      my $stats;      my $stats;
254      if ($group eq 'Genome') {      if ($group eq 'Genome' || $group eq '*') {
255          $spl->LoadGenomeData();          $spl->LoadGenomeData();
256      } elsif ($group eq 'Feature') {      }
257        if ($group eq 'Feature' || $group eq '*') {
258          $spl->LoadFeatureData();          $spl->LoadFeatureData();
259      } elsif ($group eq 'Coupling') {      }
260        if ($group eq 'Coupling' || $group eq '*') {
261          $spl->LoadCouplingData();          $spl->LoadCouplingData();
262      } elsif ($group eq 'Subsystem') {      }
263        if ($group eq 'Subsystem' || $group eq '*') {
264          $spl->LoadSubsystemData();          $spl->LoadSubsystemData();
265      } elsif ($group eq 'Property') {      }
266        if ($group eq 'Property' || $group eq '*') {
267          $spl->LoadPropertyData();          $spl->LoadPropertyData();
     } else {  
         Confess("Invalid group name $group.");  
268      }      }
269        if ($group eq 'Annotation' || $group eq '*') {
270            $spl->LoadAnnotationData();
271        }
272        if ($group eq 'BBH' || $group eq '*') {
273            $spl->LoadBBHData();
274        }
275        if ($group eq 'Group' || $group eq '*') {
276            $spl->LoadGroupData();
277        }
278        if ($group eq 'Source' || $group eq '*') {
279            $spl->LoadSourceData();
280        }
281        if ($group eq 'External' || $group eq '*') {
282            $spl->LoadExternalData();
283        }
284        if ($group eq 'Reaction' || $group eq '*') {
285            $spl->LoadReactionData();
286        }
287    
288  }  }
289  Trace("Load complete.") if T(2);  Trace("Load complete.") if T(2);
290    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.20

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3