|
@@ -0,0 +1,243 @@
|
|
|
+<?php
|
|
|
+/*
|
|
|
+ * Details about genotypes associated with stocks can be found in two ways by
|
|
|
+ * traversing the the foreign key (FK) relationships in these ways:
|
|
|
+ *
|
|
|
+ * Simple Method: stock => stock_genotype => genotype
|
|
|
+ * ND Method: stock => nd_experiment_stock => nd_experiment => nd_experiment_genotype => genotype
|
|
|
+ *
|
|
|
+ * The tripal_genetic module handles display of genotypes when stored using the
|
|
|
+ * simple method. This template handles display of genotype when stored using
|
|
|
+ * the ND Method. The ND method uses the natural diversity tables and allows for
|
|
|
+ * association or more ancilliary information.
|
|
|
+ *
|
|
|
+ *
|
|
|
+ * Within the ND tables, If a stock has genotypes then you can find the corresponding
|
|
|
+ * features by traversing the FK relationships in this manner:
|
|
|
+ *
|
|
|
+ * stock => nd_experiment_stock => nd_experiment => nd_experiment_genotype => genotype => feature_genotype => feature
|
|
|
+ *
|
|
|
+ * You can find ancilliary information about data associated with a genotype in the ND tables such as
|
|
|
+ * a contact, pub, protocol, project, genotype, dbxref by using the
|
|
|
+ * nd_experiment.nd_experiment_id value and traversing the other FK relationships
|
|
|
+ *
|
|
|
+ * stock => nd_experiment_stock => nd_experiment => nd_experiment_project => project
|
|
|
+ * => nd_experiment_pub => pub
|
|
|
+ * => nd_experiment_contact => contact
|
|
|
+ * => nd_experiment_dbxref => dbxref
|
|
|
+ * => nd_experiment_protocol => protocol
|
|
|
+ * => nd_experiment_stockprop
|
|
|
+ * => nd_experiment_stock_dbxref
|
|
|
+ *
|
|
|
+ * In the FK relationships shown above, the nd_experiment_id value represents a single
|
|
|
+ * experimental unit that may have all of the ancilliary data associated with it or none.
|
|
|
+ * If the genotype record shares an nd_experiment_id with a genotype, pub, contact,
|
|
|
+ * protocol, etc then all of that data is associated with the genotype and vice-versa.
|
|
|
+ *
|
|
|
+ * Techincally, we can skip including the 'nd_experiment' table when traversing the FK's
|
|
|
+ * because we have the nd_experiment_id value when we get the nd_experiment_stock record.
|
|
|
+ *
|
|
|
+ *
|
|
|
+ * NOTE: if the tripal_natural_diversity module is enabled this template will supercede
|
|
|
+ * the tripal_stock_genotypes.tpl.php template (provided by the tripal_genetic module).
|
|
|
+ * Therefore, this template must handle both cases for linking to features as described above
|
|
|
+ */
|
|
|
+
|
|
|
+// get the current stock
|
|
|
+$stock = $variables['node']->stock;
|
|
|
+
|
|
|
+// specify the number of genotypes to show by default and the unique pager ID
|
|
|
+$num_results_per_page = 25;
|
|
|
+$stock_pager_id = 15;
|
|
|
+
|
|
|
+// get all of the nd_experiment_stock records for this stock.
|
|
|
+$genotypes = array();
|
|
|
+$values = array('stock_id' => $stock->stock_id);
|
|
|
+$options = array(
|
|
|
+ 'return_array' = 1;
|
|
|
+ 'include_fk' => array(
|
|
|
+ 'nd_experiment_id' => 1
|
|
|
+ ),
|
|
|
+);
|
|
|
+$stock = tripal_core_expand_chado_vars($stock, 'table', 'nd_experiment_stock', $values, $options);
|
|
|
+$nd_experiment_stocks = $stock->nd_experiment_stock;
|
|
|
+if ($nd_experiment_stocks) {
|
|
|
+
|
|
|
+ // iterate through the nd_experiment_stock records and look to see if there is
|
|
|
+ // an nd_experiment_genotype record. If so, then add it out $genotypes array
|
|
|
+ foreach ($nd_experiment_stock as $nd_experiment_stock) {
|
|
|
+ $nd_experiment_id = $nd_experiment_stock->nd_experiment_id->nd_experiment_id
|
|
|
+ $nd_experiment = $nd_experiment_stock->nd_experiment_id;
|
|
|
+
|
|
|
+ // expand the nd_experiment record to include the nd_experiment_genotype table
|
|
|
+ // there many be many genotypes for a stock so we want to use a pager to limit
|
|
|
+ // the results returned
|
|
|
+ $options = array(
|
|
|
+ 'return_array' => 1,
|
|
|
+ 'include_fk' => array(
|
|
|
+ 'genotype_id' => array(
|
|
|
+ 'type_id' => 1,
|
|
|
+ )
|
|
|
+ ),
|
|
|
+ 'pager' => array(
|
|
|
+ 'limit' => $num_results_per_page,
|
|
|
+ 'element' => $stock_pager_id
|
|
|
+ ),
|
|
|
+ );
|
|
|
+ $nd_experiment = tripal_core_expand_chado_vars($nd_experiment, 'table', 'nd_experiment_genotype', $options);
|
|
|
+ nd_experiment_genotypes = $nd_experiment->nd_experiment_genotype;
|
|
|
+ if ($nd_experiment_genotypes) {
|
|
|
+ // for each of the genotypes, add them to our $genotypes array so we can
|
|
|
+ // display each one
|
|
|
+ foreach ($nd_experiment_genotypes as $nd_experiment_genotype) {
|
|
|
+ $genotype = $nd_experiment_genotype->genotype_id;
|
|
|
+ $genotypes[$genotype->genotype_id]['genotype'] = $genotype;
|
|
|
+ $genotypes[$genotype->genotype_id]['nd_experiment_id'] = $nd_experiment_id;
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+// the total number of records for the paged query is stored in a session variable
|
|
|
+$total_records = $_SESSION['chado_pager'][$stock_pager_id]['total_records'];
|
|
|
+
|
|
|
+// now iterate through the feature genotypes and print a paged table.
|
|
|
+if (count($genotypes) > 0) { ?>
|
|
|
+ <div id="tripal_feature-nd_genotypes-box" class="tripal_feature-info-box tripal-info-box">
|
|
|
+ <div class="tripal_feature-info-box-title tripal-info-box-title">Genotypes</div>
|
|
|
+ <div class="tripal_feature-info-box-desc tripal-info-box-desc">The following <?php print number_format($total_records) ?> genotype(s) have been recorded for this feature.</div> <?php
|
|
|
+
|
|
|
+ // the $headers array is an array of fields to use as the colum headers.
|
|
|
+ // additional documentation can be found here
|
|
|
+ // https://api.drupal.org/api/drupal/includes%21theme.inc/function/theme_table/7
|
|
|
+ $headers = array('Name', 'Type', 'Genotype', 'Details', 'Markers', 'Project');
|
|
|
+
|
|
|
+ // the $rows array contains an array of rows where each row is an array
|
|
|
+ // of values for each column of the table in that row. Additional documentation
|
|
|
+ // can be found here:
|
|
|
+ // https://api.drupal.org/api/drupal/includes%21theme.inc/function/theme_table/7
|
|
|
+ $rows = array();
|
|
|
+
|
|
|
+ // iterate through the genotypes and build each row of the resulting table
|
|
|
+ foreach ($genotypes as $info) {
|
|
|
+ $genotype = $info['genotype'];
|
|
|
+ $nd_experiment_id = $info['nd_experiment_id'];
|
|
|
+
|
|
|
+ // set some defaults for project and feature names
|
|
|
+ $project_names = 'N/A';
|
|
|
+ $feature_names = 'N/A';
|
|
|
+
|
|
|
+ // build the name for displaying the genotype. Use the uniquename by default
|
|
|
+ // unless a name exists
|
|
|
+ $name = $genotype->uniquename;
|
|
|
+ if ($genotype->name){
|
|
|
+ $name = $genotype->name;
|
|
|
+ }
|
|
|
+
|
|
|
+ // build the genotype type for display
|
|
|
+ $type = 'N/A';
|
|
|
+ if ($genotype->type_id) {
|
|
|
+ $type = ucwords(preg_replace('/_/', ' ', $genotype->type_id->name));
|
|
|
+ }
|
|
|
+
|
|
|
+ // build the genotype properties
|
|
|
+ $options = array('return_array' => 1);
|
|
|
+ $genotype = tripal_core_expand_chado_vars($genotype, 'table', 'genotypeprop', $options);
|
|
|
+ $properties = $genotype->genotypeprop;
|
|
|
+ $details = '';
|
|
|
+ if(count($properties) > 0) {
|
|
|
+ foreach ($properties as $property){
|
|
|
+ $details .= ucwords(preg_replace('/_/', ' ', $property->type_id->name)) . ': ' . $property->value . '<br>';
|
|
|
+ }
|
|
|
+ $details = substr($details, 0, -4); // remove trailing <br>
|
|
|
+ }
|
|
|
+
|
|
|
+ // get the features as found in the feature_genotype table and if any, add them to the $features array
|
|
|
+ // we will later add in the features list for display
|
|
|
+ $features = array();
|
|
|
+ $options = array(
|
|
|
+ 'return_array' => 1,
|
|
|
+ 'include_fk' => array(
|
|
|
+ 'feature_id' => array(
|
|
|
+ 'type_id' => 1
|
|
|
+ )
|
|
|
+ ),
|
|
|
+ );
|
|
|
+ $genotype = tripal_core_expand_chado_vars($genotype, 'table', 'feature_genotype', $options);
|
|
|
+ $feature_genotypes = $genotype->feature_genotype;
|
|
|
+ if (count($feature_genotypes) > 0) {
|
|
|
+ foreach ($feature_genotypes as $feature_genotype) {
|
|
|
+ $feature = $feature_genotype->feature_id;
|
|
|
+ $features[$feature->feature_id] = $feature;
|
|
|
+ $feature_name = $feature->name . ' (' . $feature->uniquename . ')';
|
|
|
+ if (property_exists($feature, 'nid')) {
|
|
|
+ $feature_name = l($feature_names, 'node/' . $feature->nid);
|
|
|
+ }
|
|
|
+ $feature_names .= $feature_name . '<br>';
|
|
|
+ }
|
|
|
+ $feature_names = substr($feature_names, 0, -4); // remove trailing <br>
|
|
|
+ }
|
|
|
+
|
|
|
+ // expand the nd_experiment object to incldue the nd_experiment_project table
|
|
|
+ $values = array('nd_experiment_id' => $nd_experiment_id);
|
|
|
+ $options = array('return_array' => 1);
|
|
|
+ $nd_experiment = tripal_core_expand_chado_vars($nd_experiment, 'table', 'nd_experiment_project', $options);
|
|
|
+ $nd_experiment_projects = $nd_experiment->nd_experiment_project;
|
|
|
+ if (count($nd_experiment_projects) > 0) {
|
|
|
+ foreach ($nd_experiment_projects as $nd_experiment_project) {
|
|
|
+ $project = $nd_experiment_project->project_id;
|
|
|
+ $name = $project->name;
|
|
|
+ if (property_exists($project, 'nid')) {
|
|
|
+ $name = l($name, "node/" . $project->nid, array('attributes' => array('target' => '_blank')));
|
|
|
+ }
|
|
|
+ $project_name .= $name . '<br>';
|
|
|
+ }
|
|
|
+ $project_name = substr($project_name, 0, -4); // remove trailing <br>
|
|
|
+ }
|
|
|
+
|
|
|
+ $rows[] = array(
|
|
|
+ $name,
|
|
|
+ $type,
|
|
|
+ $genotype->description,
|
|
|
+ $details,
|
|
|
+ $feature_names,
|
|
|
+ $project_name,
|
|
|
+ );
|
|
|
+ }
|
|
|
+
|
|
|
+ // the $table array contains the headers and rows array as well as other
|
|
|
+ // options for controlling the display of the table. Additional
|
|
|
+ // documentation can be found here:
|
|
|
+ // https://api.drupal.org/api/drupal/includes%21theme.inc/function/theme_table/7
|
|
|
+ $table = array(
|
|
|
+ 'header' => $headers,
|
|
|
+ 'rows' => $rows,
|
|
|
+ 'attributes' => array(
|
|
|
+ 'id' => 'tripal_natural_diversity-table-genotypes',
|
|
|
+ ),
|
|
|
+ 'sticky' => FALSE,
|
|
|
+ 'caption' => '',
|
|
|
+ 'colgroups' => array(),
|
|
|
+ 'empty' => '',
|
|
|
+ );
|
|
|
+ // once we have our table array structure defined, we call Drupal's theme_table()
|
|
|
+ // function to generate the table.
|
|
|
+ print theme_table($table);
|
|
|
+
|
|
|
+ // the $pager array values that control the behavior of the pager. For
|
|
|
+ // documentation on the values allows in this array see:
|
|
|
+ // https://api.drupal.org/api/drupal/includes!pager.inc/function/theme_pager/7
|
|
|
+ // here we add the paramter 'block' => 'features'. This is because
|
|
|
+ // the pager is not on the default block that appears. When the user clicks a
|
|
|
+ // page number we want the browser to re-appear with the page is loaded.
|
|
|
+ $pager = array(
|
|
|
+ 'tags' => array(),
|
|
|
+ 'element' => $stock_pager_id,
|
|
|
+ 'parameters' => array(
|
|
|
+ 'block' => 'genotypes'
|
|
|
+ ),
|
|
|
+ 'quantity' => $num_results_per_page,
|
|
|
+ );
|
|
|
+ print theme_pager($pager); ?>
|
|
|
+ </div> <?php
|
|
|
+}
|