|
|
| (86 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | {| class="tutorialheader"
| + | #REDIRECT [[BioMart Tutorial]] |
| − | | align="right" | {{#icon: Biomart250.png|BioMart|200|BioMart}}<br /><br />{{#icon: 170px-October2011Logo.png|October 2011 - Toronto||2009 GMOD Summer School - Toronto, Canada}}
| + | |
| − | | {{TutorialTitleLine|[[BioMart]]}}<br />
| + | |
| − | [http://gmod.org/wiki/October_2011_GMOD_Meeting 2011 GMOD Community Meeting] & <br />[http://oicr.on.ca/ Ontario Institute for Cancer Research]<br />Toronto, Canada<br />
| + | |
| − | 14 October 2011<br />
| + | |
| − | [[User:Junjun%20Zhang|Junjun Zhang]], [[User:Elena%20Rivkin|Elena Rivkin]] and [[User:Anthony%20Cros|Anthony Cros]]
| + | |
| − | |}
| + | |
| − | __NOTITLE__
| + | |
| − | | + | |
| − | | + | |
| − | This [[:Category:Tutorials|tutorial]] walks you through how to install and configure a local installation of [[BioMart]].
| + | |
| − | | + | |
| − | | + | |
| − | __TOC__
| + | |
| − | | + | |
| − | | + | |
| − | = System overview and installation =
| + | |
| − | Prerequisites for BioMart:
| + | |
| − | # Software: Java 1.6, Ant and SVN client
| + | |
| − | # OS: Linux, Mac & Windows
| + | |
| − | # Server: min. 1 GB memory, 3 GB for better performance
| + | |
| − | | + | |
| − | = Add a section here for installing VirtualBox or VMware and start up the VM =
| + | |
| − | | + | |
| − | # where to download virtualbox etc.
| + | |
| − | # where to get VM image (download? or get it from USB key)
| + | |
| − | | + | |
| − | = Downloading & Installing BioMart =
| + | |
| − | | + | |
| − | Two components are necessary for this tutorial: MartBuilder is installed form an older version of BioMart (0.7), and MartConfigurator is installed from the most recent version (0.8) (until all features are fully ported to the new version)
| + | |
| − | | + | |
| − | Installation of MartBuilder and MartConfigurator has already been done on the VM image under ~/biomart_0_7.template and ~/biomart_0_8.template, but we are going to do once together for demonstration purposes.
| + | |
| − | | + | |
| − | Refer to [http://www.biomart.org/rc6_documentation.pdf BioMart Documentation] for more information.
| + | |
| − | | + | |
| − | == Biomart 0.7 (MartJ -> MartBuilder + MartRunner) ==
| + | |
| − | | + | |
| − | MartJ contains applications necessary to create a Mart: MarBuilder and MartRunner.
| + | |
| − | | + | |
| − | Check Section 2 in [http://www.biomart.org/user-docs.pdf Installing BioMart] for more information.
| + | |
| − | | + | |
| − | Download & extract tarball content with:
| + | |
| − | | + | |
| − | $ mkdir ~/biomart_0_7 # arbitrary name of course
| + | |
| − | $ cd ~/biomart_0_7
| + | |
| − | $ wget <nowiki>ftp://anonymous@ftp.ebi.ac.uk/pub/software/biomart/martj_current/martj-bin.tgz</nowiki> # or get it from [ftp://anonymous@ftp.ebi.ac.uk/pub/software/biomart/martj_current/martj-bin.tgz MartJ]
| + | |
| − | $ tar zxvf martj-bin.tgz # creates "martj" directory
| + | |
| − | $ cd martj
| + | |
| − | $ ls bin/martbuilder.sh bin/martrunner.sh # what we care about
| + | |
| − | | + | |
| − | == Biomart 0.8 (MartConfigurator) ==
| + | |
| − | | + | |
| − | Checkout latest release using SVN:
| + | |
| − | | + | |
| − | $ mkdir ~/biomart_0_8 # arbitrary name of course
| + | |
| − | $ cd ~/biomart_0_8
| + | |
| − | $ svn co <nowiki>-r 32343 https://code.oicr.on.ca/svn/biomart/biomart-java/branches/oct_3_2011 martconfigurator</nowiki> # creates "oct_3_2011" directory
| + | |
| − | $ cd martconfigurator
| + | |
| − | $ ant # build project with ant; in the future, you may use: ant clean dist
| + | |
| − | $ ls dist/scripts/martconfigurator.sh dist/scripts/biomart-server.sh # what we care about
| + | |
| − | | + | |
| − | = Building mart =
| + | |
| − | | + | |
| − | This section will show you how to create a (simplified) mart containing 1 dataset based on the VEGA database, using MartBuilder.
| + | |
| − | | + | |
| − | == Creating mart schema (MartBuilder) ==
| + | |
| − | | + | |
| − | | + | |
| − | === Start MartBuilder ===
| + | |
| − | | + | |
| − | From the directory ~/biomart_0>7/martj, issue:
| + | |
| − | | + | |
| − | $ bin/martbuilder.sh
| + | |
| − | | + | |
| − | MartBuilder should open with an empty mart.
| + | |
| − | | + | |
| − | === Add a source schema ===
| + | |
| − | | + | |
| − | Choose ''Schema''->''Add'' to open the dialog to add a schema.
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | # Name: vega
| + | |
| − | # Database type: MySQL
| + | |
| − | # Using MyISAM: ''checked''
| + | |
| − | # Host: localhost
| + | |
| − | # Port: 3306
| + | |
| − | # Database: mini_hsap_vega
| + | |
| − | # Schema: mini_hsap_vega
| + | |
| − | # Username: biomart
| + | |
| − | # Password: biomart
| + | |
| − | ''ignore the last 3 fields (used for partitioning which is not covered in this tutorial)''
| + | |
| − | | + | |
| − | [[File:Mb_add_schema2.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | Click the ''Test'' button to ensure we can connect to the database.
| + | |
| − | Click the ''Add'' button in order to proceed with the dataset description.
| + | |
| − | | + | |
| − | You should now see the source database shown in MartBuilder (see screenshot in the next section).
| + | |
| − | | + | |
| − | === Select main table ===
| + | |
| − | | + | |
| − | We are going to create a dataset based on the tables "gene" and "transcript" (as ''main'' and ''submain'' tables respectively, as described in presentation)
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | # Right-click on the "gene" table
| + | |
| − | # Click on ''Create dataset''
| + | |
| − | ''the gene table should be highlighted already as we arrived on the current menu by clicking on it''
| + | |
| − | # add the transcript table (standard "Ctrl + click)
| + | |
| − | # Press the ''Create'' button
| + | |
| − | | + | |
| − | [[File:Mb__create_dataset.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | This shows how the dataset will be structured once materialized
| + | |
| − | | + | |
| − | [[File:Mb__dataset.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | == Materializing mart (MartBuilder->MartRunner) ==
| + | |
| − | | + | |
| − | Your dataset does not actually exist yet. In order to create it, you need to generate the SQL for it then run that SQL against your database.
| + | |
| − | | + | |
| − | BioMart offers a tool (MartRunner) that does that for you, using JDBC. The SQL used is as ANSI-compliant as possible, with some exceptions based on the RDBMS in use.
| + | |
| − | | + | |
| − | 1. We now going to transform the source data into target dataset, but before that, we have to create a target database:
| + | |
| − | | + | |
| − | $ mysql -hlocalhost -P3306 -ubiomart -pbiomart -e "create database mini_hsap_vega_mart"
| + | |
| − | | + | |
| − | In theory one could materialize a mart in the same database as the source one provided there is no table name conflicts, but this is strongly discouraged.
| + | |
| − | | + | |
| − | Also we have to have MartRunner running. Lets run it over a local port (any free one will do).
| + | |
| − | | + | |
| − | 2. Start martrunner with:
| + | |
| − | | + | |
| − | $ bin/martrunner.sh 9876
| + | |
| − | | + | |
| − | MartBuilder will send the materialization SQL to MartRunner through that port (in this example, 9876), and MartRunner will execute the transformation SQL.
| + | |
| − | | + | |
| − | Note that MartRunner may be run from another machine, as we specify its connection parameters to MartBuilder (see below).
| + | |
| − | | + | |
| − | We go back to MartBuilder, and click on the ''Build Mart'' button to pop up the following dialog:
| + | |
| − | | + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | | + | |
| − | # Datasets: gene
| + | |
| − | # Schema partitions: ''ignore''
| + | |
| − | # Target database: mini_hsap_vega_mart (the one we just manually created)
| + | |
| − | # Target schema: mini_hsap_vega_mart
| + | |
| − | # Send SQL to: MartRunner (other options are available)
| + | |
| − | # MartRunner host name: localhost
| + | |
| − | # MartRunner port number: 9876 (the one we just '''arbitrarily''' chose because it was free)
| + | |
| − | # Database server name: localhost
| + | |
| − | # Database server port number: 3306
| + | |
| − | | + | |
| − | | + | |
| − | [[File:Mb__build_mart_dialog.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | Click on the ''Generate SQL'' button
| + | |
| − | | + | |
| − | [[File:Mb__sql_generation.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | 3. Monitor progress using the Monitor MartRunner progress
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | Ensure everything is successful (green font):
| + | |
| − | | + | |
| − | [[File:Mb__job_finished.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | Your schema now contains a mart with a complete dataset ready for configuring with MartConfigurator.
| + | |
| − | | + | |
| − | = Configuring mart (MartConfigurator) - basic =
| + | |
| − | | + | |
| − | This section will show you how to configure the created VEGA mart using MartConfigurator
| + | |
| − | | + | |
| − | | + | |
| − | == Start MartConfigurator ==
| + | |
| − | | + | |
| − | Start MartConfigurator with the following command in the directory of your installation:
| + | |
| − | | + | |
| − | $ cd ~/biomart_0_8/martconfigurator
| + | |
| − | $ dist/scripts/martconfigurator.sh
| + | |
| − | | + | |
| − | | + | |
| − | === Brief intro to the main interfaces of the MC ===
| + | |
| − | | + | |
| − | * new screenshot here with blank panels
| + | |
| − | [[File:MCmain.png]]
| + | |
| − | | + | |
| − | === Add Mart ===
| + | |
| − | 1. Wizard step 1/4:
| + | |
| − | <div class="emphasisbox">
| + | |
| − | '''Fill in the fields using the following values:'''
| + | |
| − | | + | |
| − | # source profile: vega (''anything will do'')
| + | |
| − | # source type: RDBMS Mart
| + | |
| − | | + | |
| − | [[File:Mc__add_source_wizard_1.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | 2. Wizard step 2/4:
| + | |
| − | <div class="emphasisbox">
| + | |
| − | # RDBMS: MySQL (keep MyISAM)
| + | |
| − | # Host: localhost
| + | |
| − | # Port: 3306
| + | |
| − | # User: biomart
| + | |
| − | # Password: biomart
| + | |
| − | # Database: ''can leave empty for now''
| + | |
| − | [[File:Mc__add_source_wizard_2.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | 3. Wizard step 3/4:
| + | |
| − | <div class="emphasisbox">
| + | |
| − | Select ''mini_hsap_vega_mart'', the mart that we just built using MartBuilder/MartRunner and based upon the ''mini_hsap_vega'' database
| + | |
| − | | + | |
| − | [[File:Mc__add_source_wizard_4.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | 4. Wizard step 4/4:
| + | |
| − | <div class="emphasisbox">
| + | |
| − | # Create naive configuration
| + | |
| − | # Choose the main table ''gene__gene__main'' (only one)
| + | |
| − | [[File:Mc__add_source_wizard_5.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | 5. Done!
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | You are now '''connected'''!
| + | |
| − | | + | |
| − | The panel on the left corresponds to source schemas; in our case we only have one mart that has one dataset: ''mini_hsap_vega_mini'', but there could be more
| + | |
| − | | + | |
| − | The panel on the right corresponds to configuration of those source schemas (accessibility, rendering, linking, ...)
| + | |
| − | | + | |
| − | [[File:Mc__connected.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | === Creating Access Point ===
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | Simply drag-and-drop the source from the left side (''Source'' frame) to anywhere on the right side (''Portal'' frame)
| + | |
| − | | + | |
| − | It will add an access point to the mart. The default name is ''mini_hsap_vega_mart_ap'', ''ap'' standing for ''Access Point'', but you can give it a name of your choice.
| + | |
| − | | + | |
| − | Note that clicking the ''Add Access Point'' button would yield the same result. You would then be given a list of the existing marts to choose from.
| + | |
| − | | + | |
| − | [[File:Mc__ready.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | === Customizing configuration ===
| + | |
| − | | + | |
| − | <div class="emphasisbox">
| + | |
| − | Double-click on the access point ''mini_hsap_vega_mart_ap'' to bring out the configuration editor (will be detailed in the following section)
| + | |
| − | | + | |
| − | [[File:Mc__config.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | | + | |
| − | === Deploying BioMart Server (Jetty) ===
| + | |
| − | | + | |
| − | In order to deploy the application on Jetty, one has 2 options:
| + | |
| − | | + | |
| − | * GUI approach: Using the ''Start Server'' button in the upper right corner
| + | |
| − | * CLI approach:
| + | |
| − | ** Save the the current state (referred to as ''registry'' in MartConfigurator)
| + | |
| − | ** Manually start the server:
| + | |
| − | | + | |
| − | $ dist/scripts/biomart-server.sh start
| + | |
| − | | + | |
| − | * GUI approach:
| + | |
| − | ** Using the ''Start Server'' button will result in prompting a dialog for saving the registry.
| + | |
| − | ** The server will be deployed on your local machine, port 9000 by default (unless specified differently in .biomart.properties file).
| + | |
| − | ** Your web page should open automatically when the local server is ready.
| + | |
| − | | + | |
| − | == Stopping the server ==
| + | |
| − | | + | |
| − | * GUI approach: Using the ''Stop Server'' button in the upper right corner
| + | |
| − | * CLI approach:
| + | |
| − | | + | |
| − | $ dist/scripts/biomart-server.sh stop
| + | |
| − | | + | |
| − | | + | |
| − | === Using deployed application ===
| + | |
| − | | + | |
| − | The interface is intuitive, typical interaction involve choose a number of attributes and filters and obtaining results accordingly.
| + | |
| − | | + | |
| − | | + | |
| − | = Configuring mart (MartConfigurator) - more advanced =
| + | |
| − | | + | |
| − | From the configuration editor (see previous section)
| + | |
| − | | + | |
| − | | + | |
| − | == Configuration editor ==
| + | |
| − | | + | |
| − | === Description ===
| + | |
| − | | + | |
| − | * ''north'': Configuration tree
| + | |
| − | ** ''Show sources view'': where one can modify config in a way that will affect all access points
| + | |
| − | ** ''Show access point view'': where one can modify individual access point's configs specifically
| + | |
| − | ** ''Show both'': most typical usage
| + | |
| − | *** ''north west'': source view
| + | |
| − | *** ''north east'': access point view
| + | |
| − | <div class="emphasisbox">
| + | |
| − | [[File:ConfigurationEditor.png]]
| + | |
| − | </div>
| + | |
| − | | + | |
| − | * ''south'': Editor frame
| + | |
| − | ** ''south west'': property names
| + | |
| − | ** ''south east'': property values
| + | |
| − | | + | |
| − | === Notes ===
| + | |
| − | | + | |
| − | Only properties whose name appears in blue font can be modified.
| + | |
| − | | + | |
| − | Each view as a ''Find'' search box that allows to quickly find attributes/filters based on their names
| + | |
| − | | + | |
| − | Also very convenient, the attributes and filters in each view offer an ''Show in the [opposite view]'' item in their context menu. It filters the opposite view side to show the counterpart filter/attribute
| + | |
| − | | + | |
| − | == Containers ==
| + | |
| − | | + | |
| − | Typical properties that can be changed:
| + | |
| − | | + | |
| − | * displayname
| + | |
| − | * description
| + | |
| − | * hide: whether attribute should be hidden or not
| + | |
| − | * enableselectall: offer checkbox allowing selection of all attributes/filters in the given container
| + | |
| − | | + | |
| − | | + | |
| − | == Attributes ==
| + | |
| − | | + | |
| − | Typical properties that can be changed:
| + | |
| − | | + | |
| − | * displayname
| + | |
| − | * description
| + | |
| − | * hide
| + | |
| − | * linkouturl: to make result values linkable to an external resource
| + | |
| − | * datatype: String, Integer, Float, Boolean (useful mostly for reordering)
| + | |
| − | | + | |
| − | | + | |
| − | == Filters ==
| + | |
| − | | + | |
| − | Typical properties that can be changed:
| + | |
| − | | + | |
| − | * displayname
| + | |
| − | * description
| + | |
| − | * type (covered in the next section)
| + | |
| − | * qualifier: whether to use "=", "<=", ">=", "LIKE" operations
| + | |
| − | * spliton: separator for filter list values (see below)
| + | |
| − | | + | |
| − | | + | |
| − | == Filters types ==
| + | |
| − | | + | |
| − | === Regular filters ===
| + | |
| − | | + | |
| − | Typically used to (suprisingly) filter data based on values of interest (for instance a specific gene, or location, or type, ...)
| + | |
| − | | + | |
| − | === Filter lists ===
| + | |
| − | | + | |
| − | They are considered filter themselves, but actually contain a list of regular filters
| + | |
| − | | + | |
| − | | + | |
| − | === Linking ===
| + | |
| − | | + | |
| − | Set Filter typesSet Attribute URLSelect GUI type
| + | |
| − | | + | |
| − | Creating Links between sources
| + | |
| − | | + | |
| − | If two data sources contain common information (e.g. a Gene/Protein ID), this can be used to create a link, allowing filters and attributes from one data source to appear in the other. These are called “pointer attributes” and “pointer filters,” and the attribute or filter to which they point is called the “target. ”To add a pointer to an access point, double click on that access point in the portal tab to edit it. In the top left corner of the editing window, click on the Import from sources button.
| + | |
| − | | + | |
| − | You will be given a list of the existing data sources to choose which one you would like to make an access point for. After giving the new access point a name of your choice, it will appear in the GUI tab.
| + | |
| − | Double-clicking on the access point icon will open a new window that allows you to modify the access point.
| + | |
| − | References
| + | |
| − | | + | |
| − | | + | |
| − | = More exercises with MartConfigurator =
| + | |
| − | | + | |
| − | == Rename 'default' GUI tab to "Form" ==
| + | |
| − | # Right-click on the tab --> ''Rename''
| + | |
| − | # enter new name: "Form"
| + | |
| − | == Add new GUI tab ==
| + | |
| − | # Click on the "+" sign next to the latest GUI tab
| + | |
| − | # Enter name of the new tab: "Wizard"
| + | |
| − | # Right-click on the newly created tab --> ''Set GUI type'' --> ''MartWizard''
| + | |
| − | == Add a URL-based marts source ==
| + | |
| − | #* Add remote mart (URL Mart) Using backward compatibility (from previous BioMart versions: <= 0.7)
| + | |
| − | # In the ''Source'' view: ''Add Mart''
| + | |
| − | # Select ''URL Mart'' --> ''Next''
| + | |
| − | # Input the following values:
| + | |
| − | #* Protocol: http
| + | |
| − | #* Host: www.biomart.org
| + | |
| − | #* Port: 80
| + | |
| − | #* Path: /biomart/martservice
| + | |
| − | # Choose source: "vega (url)" --> ''Next'' (we will only need "REACTOME" later)
| + | |
| − | # Select all 3 datasets and click ''Next''
| + | |
| − | ## Uncheck ''import each datasets to individual marts, one dataset per mart'' --> ''Finish''
| + | |
| − | #* Backward compatibility is run in the background in order to convert a mart configuration in 0.7 format to one in 0.8
| + | |
| − | # A datasource called "gene_vega" should appear on the right-hand side panel (datasource panel)
| + | |
| − | # Reproduce the same process for "REACTOME (url)", we will need it later
| + | |
| − | == Add access points for the URL marts ==
| + | |
| − | # For both "vega" and "REACTOME", add access points to the "Form" GUI tab
| + | |
| − | # For both "vega" and "REACTOME", add access points to the "Wizard" GUI tab
| + | |
| − | Re-deploy server again
| + | |
| − | == Attributes ==
| + | |
| − | # Attribute linkouturl:
| + | |
| − | ## TODO
| + | |
| − | # Attribute datatype:
| + | |
| − | ## TODO
| + | |
| − | == Filters ==
| + | |
| − | # Single select: "Chromosome"
| + | |
| − | ## Open the configuration panel and choose ''Show both'' view
| + | |
| − | ## In the ''Source'' view, search for the filter called "Chromosome" (Using the ''Find'' button)
| + | |
| − | ## Change the ''type'' to singleSelect in the south-west panel (property editor for the ''Source'' view)
| + | |
| − | # Multi-select: "Gene type"
| + | |
| − | ## In the ''Source'' view, search for the filter called "Gene type" (Using the ''Find'' button)
| + | |
| − | ## Change the ''type'' to multiSelect in the south-west panel (property editor for the ''Source'' view)
| + | |
| − | # Dropdown options: "Chromosome" & "Gene type"
| + | |
| − | ## Right-click on the filter of interest ("Chromosome" & "Gene type")
| + | |
| − | ## Select ''Dropdown options'' in the menu
| + | |
| − | ## For each dataset (''hsapiens'', ''mmusculus'', ''drerio''), click on the ''Update'' button in order to populate the values based on the database content
| + | |
| − | #: Note that one may also manually add/remove values
| + | |
| − | # Composite filter: "Multiple Chromosomal Regions"
| + | |
| − | ## In the ''Source'' view, search for the filter called "Multiple Chromosomal Regions (Chr:Start:End:Strand)" (Using the ''Find'' button)
| + | |
| − | ## Change the following properties:
| + | |
| − | ##* type: upload (temporary name - under development)
| + | |
| − | ##* spliton: ":" (filter values are separated by a colon - do not include the quotes obviously)
| + | |
| − | ##* operation: and (only one available for now)
| + | |
| − | ##* filterlist: chromosome_name,start,end,strand (the 4 regular filters composing this composite filter)
| + | |
| − | # Boolean filter list: no covered here
| + | |
| − | == Importing attribute ==
| + | |
| − | # We want to add a pathway attribute to the vega "Form" GUI (of MartForm type). In order to do that we must:
| + | |
| − | ## Under the "Form" GUI tab, double-click on the "gene_vega_ap" access point to open configuration dialog for it
| + | |
| − | ##: It is important to open "gene_vega_ap" first as opposed to "pathway_ap", since we are going to add a "pathway" attribute to "gene_vega" and not the opposite
| + | |
| − | ## Use the ''Show both'' view
| + | |
| − | ## On the right-hand side (''Access Point'' view), select the "root --> Attributes" container
| + | |
| − | ## Right-click --> ''Add container''
| + | |
| − | ## Type in name, for instance "Pathway" since we're importing a pathway attribute
| + | |
| − | ## On the left-hand side (''Source'' view), change source to ''pathway''
| + | |
| − | ## In the ''Source'' view, search for the filter called "Pathway name" (Using the ''Find'' button)
| + | |
| − | ## Drap-and-drop the selected attribute on the left-hand side ("Pathway name") into the newly created container in the right-hand side ("Pathway")
| + | |
| − | ##: Note: this will open the link dialog as we need to specify how to link those 2 datasets
| + | |
| − | ## You can keep default link name ("pathway-gene_vega-link") and click ''Next''
| + | |
| − | ## Choose attribute(s) to join on (this should not be the same attribute as the one we are importing as it would not add any information, although nothing prevents it)
| + | |
| − | ##* left-hand side: In the ''Source'' view, search for the filter called "hsgene" (Using the ''Find'' button)
| + | |
| − | ##* Double-click on it to add it
| + | |
| − | ##* right-hand side: In the ''Access Point'' view, search for the filter called "Gene ENSEMBL ID" (Using the ''Find'' button)
| + | |
| − | ##* Double-click on it to add it
| + | |
| − | ##: Note that one could link on more than one attribute provided that there are an equal number of attributes on each side
| + | |
| − | ##: [[File:Mc_link.png]]
| + | |
| − | ## Keep default setting for the next page and ''Finish''
| + | |
| − | ## The newly added attribute should now show in the gene_vega_ap access point
| + | |
| − | # Re-deploy the server and observe behavior of the imported pathway attribute
| + | |
| − | ## TODO
| + | |
| − | == Importing filter ==
| + | |
| − | # Follow the same steps as with "Pathway name" attribute for its counterpart filter ("root --> Filters --> FILTERS: --> FEATURES: --> Pathway --> Pathway name")
| + | |
| − | # The link already exists so there will be no link creation dialog opening
| + | |
| − | # Re-deploy the server and observe behavior of the imported pathway filter
| + | |
| − | | + | |
| − | = Querying a BioMart server via REST API =
| + | |
| − | | + | |
| − | == MetaData queries ==
| + | |
| − | | + | |
| − | http://localhost:9000/martservice/marts
| + | |
| − | | + | |
| − | http://localhost:9000/martservice/datasets?mart=gene_vega
| + | |
| − | | + | |
| − | http://localhost:9000/martservice/accesspoints?datasets=&mart=gene_vega
| + | |
| − | | + | |
| − | http://localhost:9000/martservice/attributes?dataset=hsapiens_gene_vega&mart=gene_vega
| + | |
| − | | + | |
| − | http://localhost:9000/martservice/filters?dataset=hsapiens_gene_vega&mart=gene_vega
| + | |
| − | | + | |
| − | == Data query ==
| + | |
| − | | + | |
| − | <xml>
| + | |
| − | <Query processor="TSV" header="true" limit="-1" client="webbrowser">
| + | |
| − | <Dataset name="hsapiens_gene_vega" config="gene_vega_ap">
| + | |
| − | <Filter name="chromosomal_region" value="2:1000000:2000000:1,4:9000000:11000000:-1"/>
| + | |
| − | <Filter name="biotype" value="protein_coding"/>
| + | |
| − | <Attribute name="vega_gene_id"/>
| + | |
| − | <Attribute name="vega_transcript_id"/>
| + | |
| − | <Attribute name="vega_translation_id"/>
| + | |
| − | <Attribute name="chromosome_name"/>
| + | |
| − | <Attribute name="start_position"/>
| + | |
| − | <Attribute name="end_position"/>
| + | |
| − | <Attribute name="strand"/>
| + | |
| − | <Attribute name="band"/>
| + | |
| − | </Dataset>
| + | |
| − | </Query>
| + | |
| − | </xml>
| + | |
| − | | + | |
| − | Paste this piece of XML in a web browse address as:
| + | |
| − | | + | |
| − | http://localhost:9000/martservice/results?query=paste_query_xml_string_here
| + | |
| − | | + | |
| − | | + | |
| − | To read more about BioMart, refer to the recent articles describing the BioMart software and its applications.
| + | |
| − | | + | |
| − | 1. Zhang J, Haider S, Baran J, Cros A, Guberman JM, Hsu J, Liang Y, Yao L, Kasprzyk A. BioMart: a data federation framework for large collaborative projects. Database (Oxford). 2011 Sep 19:2011:bar038.
| + | |
| − | | + | |
| − | 2.Guberman JM, Ai J, Baran J., et al. BioMart Central Portal: An Open Database Network for the Biological Community. Database (Oxford). 2011 Sep18;2011:bar041.
| + | |
| − | | + | |
| − | 3. Zhang J, Baran J, Guberman JM, Haider, S, Hsu J, Liang Y, Rivkin E, Wang J, Whitty B, Wong-Erasmus M, Yao L, Kasprzyk A. International Cancer Genome Consortium Data Portal - a One-stop Shop for Cancer Genomics Data. Database (Oxford). 2011 Sep19;2011:bar026.
| + | |
| | | | |
| | [[Category:BioMart]] | | [[Category:BioMart]] |
