Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 3.39 KB

README.md

File metadata and controls

81 lines (55 loc) · 3.39 KB
Raw

BridgeDbMatlab functions

Functions to use the BridgeDb webservice in Matlab. BridgeDb is a tool for identifier mapping.

Learn about BridgeDb at http://www.bridgedb.org/ and read about it in this paper:

Van Iersel, M.; Pico, A.; Kelder, T.; Gao, J.; Ho, I.; Hanspers, K.; Conklin, B.; Evelo, C. BMC Bioinformatics 2010, 11, 5, https://doi.org/10.1186/1471-2105-11-5

The DOI of this repository is ADD-DOI

License: AGPL-3

BridgeDb-matlab Usage Instructions:

Please download Matlab first, as well as Python (instructions). For Python, check if you use a supported version (version 2.7, 3.7, and 3.8 are currently supported) On the command line (Bash/Unix users):

python -V

Check if Python is setup correctly in Matlab, from the Matlab Command Window:

pe = pyenv

Download this repository:

git clone https://github.com/bridgedb/BridgeDb-matlab.git

Local Matlab installation:

  • Start your version of Matlab [tested with Matlab 2021A]
  • Add the folder where you downloaded this code (e.g. BridgeDb-matlab) to your working directory: Right-click, 'Add to Path'/'Selected Folders and Subfolders'

image

  • Open the folder (double click or rightclick/Open). Your Current folder in Matlab should look like this now:

image

Matlab Online:

MatlabOnline_Upload

When the upload succeeded, you should see the BridgeDb-Matlab folde rin your drive, and in you Matlab Online Instance: MatlabOnline_drive

MatlabOnline_workingdirectory

  • Add the folder to your working directory:

MatlabOnline_addToPath

Executing BridgeDb Code

  • In the Matlab command window, type the following command to check your pathway directory:
pwd
  • Switch to the folder containing your code (if needed):
cd('PATH/TO/FILE')
  • Execute the XrefsBatch mapping function on the test data, located in the 'testData' folder, as such:
 xrefsBatch('BridgeDb-matlab/testData/case1-example.tsv', 'Homo sapiens', 'H')
  • Your results are stored in your working directory, as a file called 'mappings.csv' (located in the folder testData):

image

  • You can view your results by double clicking the mappings.csv file in the Matlab working directory:

image