Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
1
Software Training Guide
Document Revision: G
This manual describes how to install and use the genomics analysis software, IrysView®, to
analyze and visualize data generated by the Irys® instrument. Review the release notes to
best determine what features have been added or modified since our last release.
http://www.bnxinstall.com/training/docs/IrysView_Software_Installation_Guide_251.pdf
Click the following link to view the new features and changes for IrysView 2.5.1:
http://www.bnxinstall.com/training/docs/IrysView_ReleaseNotes_251.pdf
3 Demo
Beyond the training datasets noted in the following sections there is also a collection of
public data available on the Bionano Genomics corporate website in the Science
section. We provide these datasets to enable the community to better understand and
interact with NGM data.
• FASTA File
(double): http://www.bnxinstall.com/training/DataSet/Ecoli_MG1655_double.zip
• Open the IrysView Application. Select Help | About IrysView from the menu bar.
Windows (not remote Linux) versions should be as listed below:
• The following commands in their respective installation paths will give you the current
version installed:
o python -V
• If the correct IrysView version is not displayed, close the IrysView application.
Uninstall IrysView through Control Panel Program and Features and then re-
install from: http://www.bnxinstall.com/IrysView/IrysView.htm
The main pane of IrysView is divided into a right and left section. The left section
contains the Runs, Maps and Comparisons tabs for importing datasets, toggling selected
runs, and launching analysis jobs. The right section contains the Reports, Data and
Analysis tabs for visualizing the corresponding analysis results.
This matrix describes the three main steps of the workflow along the first blue column.
The green columns denote the types of analysis output.
Runs
• Molecules pane: Maintains a list of all the imported datasets and BNX files.
• Analysis pane: Buttons for Merge, Molecule Quality Report and De Novo
Assembly.
• Assembled Maps pane: Lists the assembled genome maps from de novo
assembly. The Import button allows the import of externally generated De
Novo runs.
• Compared Maps pane: Lists the pair of compared maps (*.xmap) generated
from Compare buttons in the previous Maps tab.
• Analysis pane: Allows Import of XMAP files and Export of FASTA, BED, and
AGP files.
Report
• Accessed from Runs tab: Loads Run and Molecule Quality Reports.
• Accessed from Maps tab: Loads the Assembly and Map Quality Reports.
Data
• Accessed from Runs tab: Loads molecules, labels, images and repeats data.
Analysis
• Accessed from Runs tab: Loads Molecules to Anchor alignments from Molecule
Quality Report.
• Accessed from Maps tab: Loads assembled Genome Maps vs Anchor alignments.
All
File
Note: These menu items can also be accessed directly from the toolbar.
• Save workspace Then Exit – Save all changes to the workspace before exit.
This may take some time for a large workspace.
Warning: Keep workspaces clean, free of unused datasets, ambiguous naming or multiple
versions of similar analyses. Large and overly complicated workspaces are susceptible to
data corruption. Please see Workspace Section 6 for further details.
Tools
• Snipping Tool – Screen capture Cut & Paste tool (Windows 7 and later).
• Combine CMAPS – Concatenate multiple CMAP files into one CMAP. The
first option “Keep Original CMap Id” will concatenate the 2 CMAPs into one
without changing the CMap Id. The “Increment CMap Id” option will
increment the CMap Id so that they are unique throughout the file.
Import
A dropdown menu that allows a user to import existing data into IrysView:
• De Novo Run… - Import an already finished De Novo run. This option allows
the user to import a completed De Novo run into IrysView. A dialog is
displayed which allows the user to select the location of the De Novo run
either on the local computer or on the remote server:
Fig. 1 Fig. 2
If the data is on a remote server then “check” the Use Remote Server box
(as shown in Fig. 1). This will enable the remote section of the dialog
where the user shall enter the location of the data (this should include the
“output” folder). Also, all the necessary information for connecting to the
server should be filled in. A test button can be used to test the connection
to the server. Click OK to begin the import of the De Novo run.
The user can also import the results from the local computer and in this
case the user should “uncheck” the Use Remote Server box (as shown in
Fig. 2). This will enable the Local section of the dialog. The user can use
the Browse… button to locate the De Novo data (this should include the
“output” folder). Click OK to begin the import of the De Novo run.
If the “all.bnx” file exists, IrysView will create a new dataset in the Runs
tab and then import the data into this run.
If the “all.bnx” file is missing, then a dialog shall be displayed to get the
name of the folder to be used for the data import.
Help
• About IrysView – Shows all supporting software versions and the workspace
directory.
• View Log – Allows the user to Copy to Clipboard or Export to a file the
contents of the IrysView log files.
6 IrysView Workflow
• When opening IrysView, choose between Open Existing Workspace and Create
New Workspace. Note that a workspace must be created to view maps.
• Navigate to the workspace folder. This is the parent directory of four auto-
generated folders: Contigs, Datasets, Imports and Merged Molecule Sets.
6.4 Options
There are two ways to import data into the Runs Tab: Import->Dataset… from Import
Menu Option and Drag ‘n Drop Datasets.
Note: Global filtering by molecule size and label SNR is automatically applied to all imported
datasets. The filter type and values can be changed in View/Options menu.
• Choose the parent directory of the date folders (e.g. 2012-08) from the top drop
down list or from Browse.
• Sort by When Collected or Sample Name, and Filter by using Containing Text to
find your data.
• If a dataset is not ready for import, run AutoDetect first and then try again.
• Once data has been imported a Y will appear under the In WS column.
• Datasets can be directly imported by dragging its run folder into the Runs tab.
• De Novo Run… - Import an already finished De Novo run. This options allows the
user to import a completed De Novo run into IrysView. A dialog is displayed
which allows the user to select the location of the De Novo run either on the local
computer or on the remote server:
Fig. 1 Fig. 2
o If the data is on a remote server then “check” the Use Remote Server box
(as shown in Fig. 1). This will enable the remote section of the dialog
where the user shall enter the location of the data (this should include the
“output” folder). Also, all the necessary information for connecting to the
server should be filled in. A test button can be used to test the connection
to the server. Click OK to begin the import of the De Novo run.
o If the “all.bnx” file exists, IrysView will create a new dataset in the Runs
tab and then import the data into this run.
o If the “all.bnx” file is missing, then a dialog shall be displayed to get the
name of the folder to be used for the data import.
• Hybrid Scaffold Run… - Import an existing Hybrid Scaffold run into IrysView. The
same dialog box for the import of a De Novo run is displayed. The user shall enter
the location of the Hybrid Scaffold data including the “output” folder. The user has
the option to select a local or remote import.
Fig. 1 Fig. 2
• Open Temp Directory - Opens the local temporary folder of De Novo assembly
outputs.
As soon as scans become available from the Irys instrument after being processed by
AutoDetect, the user can pull them into IrysView.
• Click Runs tab. Right click on a Run and choose Update Scans.
2. Click (not checkmark) one of the runs then press Merge button on the Analysis pane.
• From the Merge Molecules dialog, Select All Results to Merge or checkbox Select
To Merge individual runs. The number of runs selected is displayed in the top right
corner of the dialog. The user can set the name of the merged dataset in the
Dataset Name field just below the list of runs.
3. Once merging is completed a Merged Molecule Set will be created in the Runs tab.
1. To view the workspace directory, choose Workspace from the View pull down menu.
Warning: A workspace is not a regular file system. It is a custom database. All interactions with
the workspace must be initiated within IrysView to maintain integrity. A non-expert user should
not directly manipulate this folder or any of its content. Should corruption occur, running the
CleanIrysViewConfigs tool outside of IrysView and creating a fresh workspace should fix the
problem.
2. The All tab on the left shows the workspace file content.
3. Molecule, Label statistics, Images and Repeats can be selected from the top toolbar.
5. Select Labels for the overall label distribution and statistics. The labels channels are
hardcoded to show Green (channel 1) and Red (channel 2).
(Note: This feature is intended for use with bnx files that contain a single run.)
a. Find any molecule by clicking Ctrl+F, or View menu + Find Molecule, and enter the
molecule ID and click OK. The image will center to that molecule.
a. Molecules and labels can be filtered by Length, Intensity, SNR and Channel.
Warning: This filtered data will not be used with any other analyses, such as Molecule
Quality Report or De Novo Assembly. It is for data exploration display purpose only.
b. Filtered and Unfiltered molecule data can also be displayed by selecting the
appropriate selection in the Molecules group.
c. The user can now save the tabular data into a tab delimited text file.
8. Repeats
a. Select a Run.
c. Select the appropriate filter Repeat Stretch Tolerance value. Click Apply.
• Filter by Repeats Stretch Tolerance, Min. Repeat Units, Bin Size to be displayed
on the graph and Color Channel.
f. New BNX
• A new Run can be created using either the default or custom filter values.
• There are three types of runs: BNX with only repeats, BNX without repeats and
BNX with masked repeats.
• Click Generate to apply the filter. The new run is automatically imported into the
Runs tab.
Select a Run from the Molecules pane. A Run Report will load in the Report tab.
2. To refresh the report view, Right-click on the run and select the Show Run Report
option:
Molecules and Labels can be filtered by Size and SNR before De Novo assembly. There
are 2 filtering options: Local filter sets the parameters for one selected dataset, and Global
filter applies to more than one datasets. When set from the View-Options menu item, the
filter values will globally affect all subsequently imported datasets.
To filter the runs already imported into the workspace, follow the steps below.
1. For local filter, right click on a Run and choose Apply Local Size & SNR.
a. Molecule Length
From the pop up Options window and Detect tab, select a minimum cut-off
molecule length in kbp. By default, 100 kbp is used as the minimum length cut-
off. For larger, complex genomes, 150 kbp cutoff is recommended.
• Fixed Threshold. The user can enter any fixed value between 2.0 and
8.0. For most instruments, the recommended value is 2.75.
c. Filter BNX on import. Check the box to automatically filter the BNX file
when importing a Run.
1. Import a Reference
a. Under the References pane press Import.
b. Search for file types CMAP, FASTA, or FA. For example, MG1655.fa.
c. In the Import Fasta File window, verify the files.
e. Press Digest to CMAP to create the CMAP file with in-silico digestion of FASTA to
CMAP using the selected enzyme or Import as Fasta to import raw FASTA without
in-silico digestion. The Digest to CMAP file will generate a key file that is required
for exporting the results of hybrid scaffold xmap in the Comparisons tab as FASTA.
2. Checkmark a Run and the imported Reference Map, then press Molecule Quality
Report. A pop up Options Dialog is displayed.
5. Local or Remote
Execution time can be reduced with a fast multicore remote system, if available.
a. From Options menu and Configure tab, check the Remote checkbox and click OK.
7. Molecules aligned against the in silico digested Reference will appear under the
Analysis tab. Please refer to the View Comparison section below for details on the
toolbar display options.
1. Checkmark (not highlight) a Run from the Runs tab. Optionally, checkmark a
Reference from the References tab. Then press De Novo Assemble.
• Edit the specific values in the table. Click on each parameter to see more
explanation at the bottom.
• Save - Overwrite the selected optArguments file, or save to a new file.
• Remove - Delete the currently selected arguments.xml from the dropdown list.
3. From the Configure tab, checkbox Remote to execute remotely or leave unchecked to
execute locally.
• Verify the paths of the Parent, Scripts, Tools and Data directories.
• Workspace – default current workspace or custom Data subdirectory name
• Check SGE if headnode Sun Grid Engine has been configured.
4. Press OK to start De Novo Assembly.
5. Status
• The highlighted Run will turn green during assembly.
• During the download of the results from the server, IrysView now does an MD5
check of the files. IrysView will retry a maximum of 10 times if the MD5 check
fails for the file. When the maximum number is reached a dialog box is displayed
as shown below:
• You can contact your network administrator to check your network and then click
“Yes” to continue, or you can click “No” and the download will fail resulting in a
failed run.
6. Once assembly has completed, the highlighted Run background turns white, and an
Assembled Map appears in the Maps tab. If the assembly does not appear, right click
on the panel to Refresh Workspace.
7. Molecule “pile ups” aligning to the De novo assembly genome maps will load in the
Data tab. Please refer to the View Comparison section below for details on the toolbar
display options.
• Right-click Swap Channels on a Run in the Runs tab to swap the colors in the bnx
file and automatically imports the swapped data back into IrysView.
1. From the Runs tab, checkmark a Molecules Run and a References map then press
Molecule Quality Report.
2. Click the Analysis tab to see the Reference vs. Molecules visualization.
3. In general, Reference-to-Molecule XMAPs can also be loaded directly from the File |
Open menu of the viewer in the Analysis tab of Runs.
6.22 Molecules-To-Maps
6.23 Query-to-Anchor
1. On the Maps tab, checkmark any pair of maps, such as Assembled Map and
Reference, or Imported Map and Reference, or Assembled Map and Imported Map,
then press Compare.
Or
Either
Or
6.24 Molecules-to-Maps-to-Reference
ii. A file browser is displayed for you to navigate to the folder with the molecules to
maps alignments:
iii. The location of the molecules can be found by hovering over the selected dataset
For example the selected dataset is A7_11409_6244_s4_2012-08-
22_17_26_Assemble_Molecules_to_MG1655.fa_Nt.BspQI_merged.
vi. Select any .xmap file in the folder. IrysView will automatically select the
appropriate file for the selected query. Click the Open button to display the
molecules.
vii. Note: The folder location for the molecules only needs to be loaded once per
viewing session per dataset. Subsequent session viewing of molecules queries
will only require selecting the Show Molecules menu option in (i).
5. Please refer to section 6.26 for additional display and navigation options.
1. From the the Maps tab, checkmark an assembly (either Assembled Map or Imported
Map) and a reference (fasta only). The latter must be selected from the References
pane of the Maps tab.
assembled genome maps appear as query maps. Click to render anchors in Blue.
7. Select Edit HS Cut File… option from the menu by right clicking on the dataset.
8. The cuts made by Hybrid Scaffold show up as a bed feature when the BNG_NGS
dataset is selected.
or
2. Zooming and Panning can be done with keyboard and mouse, or by keyboard alone.
• Snip tool
• Swap Anchor/Query
• Switch Colors
• Text Font size for Labels
• Pen size
• Show imported BED, SV and CN features. These overlays will only appear in
single selected anchor, not in the whole genome, view.
Type - Polysomy (if ZValue > 10) or Monosomy (if ZValue < -10)
Z- Mean Absolute Deviation (MAD) of the affected chromosome’s representation
from the median value observed in euploids, divided by the MAD of euploid
chromosomal representations.
• Import external BED files that represent overlay visuals on Anchor maps. To
improve rendering time, include ‘# Min Size:Tab N’ in the .bed file header.
• Remove imported BED files from the reference .cmap file, and the current .xmap
directory. The source .bed file will not be deleted if it is from a different directory.
• Show the imported text-based BED files.
• Similarly, for SV and Copy Number files.
o BED structures can also be imported from File Import BED and are
overlaid over each anchor (Note: to view molecules please refer to section 6.24.4
item 4).
o Display options
o Molecules confidence.
o Stretch Matches
o Click the “Update” Button to populate the selected samples from the Compared
Maps pane into the Multi Sample Selection pane. This is the collection of samples
that are to be displayed in the 3 Level view.
o To remove the dataset from the Multi Sample Pane, right click and select the
“Remove Sample” and then click the “Display” button to redraw the updated list of
samples.
o Hover over the label marked S1 etc. on the left to display a tool tip for the name
of the sample.
o Example of Deletion
o Example of Inversion
o Individual tracks can be moved by holding down the shift key and dragging the
track to its new location.
6.31.2 BNX
6.31.3 BED
Use this option to export the BED formatted file. One can export the Anchoring
information into the BED file.
Use this option to export an AGP format file. One can export the Scaffolds information
into the AGP file. The AGP export takes an optional Component ID key file as input. The
key file maps FASTA ID and cmap ID.
Use this option to export FASTA format file. The export requires a backing fasta file and
a Component ID key file. The key file is either created by Knickers or by IrysView if a
reference FASTA file was imported and converted to a CMAP.
The nickase enzyme sequence will appear in the exported FASTA at each cmap label
position.
An NCBI Export package option has been added to the export dialog for comparison
maps. The zip file will contain the coordinate map file, AGP file, FASTA files, and Hybrid
Scaffold CMAP files. The NCBI Header Values provided will be written into the
appropriate file headers.
IrysView cannot be closed while a local job is running. If IrysView is closed while running
a local job, the running process will be terminated.
You can run multiple instances of IrysView ONLY FOR VIEWING OF DATA.
Use ONLY ONE instance of IrysView if you are PERFORMING ANY DATA ANALYSIS
such as MQR, De Novo Assemble, etc.
The remote job will continue to run. IrysView remembers that a remote job was running.
The following will happen when IrysView starts up:
1. IrysView will copy over the files from the remote server if the remote job completed.
2. IrysView will monitor the progress of the job and download the files from the remote
server.
You need to first select the dataset in the Maps tab in order for the .xmap to appear in
the Comparison tab. This selection enables IrysView to drill-down from the selected
Query (from the Comparison tab) to the related Molecules (in the Maps tab).
No. Hybrid Scaffold was validated to run on a remote server with perl 5.10.X, 5.14.X, or
5.16.X installed.
IrysView 2.3 and later requires that the SMAP entry be in the XMAP file. Runs generated
with previous versions of RefAligner placed the SMAP into the *r_cmap file. Use the File-
>Import->SMAP from within the Comparisons->Analysis to import the SMAP. This will
automatically add an entry into the XMAP file for you so the next time you open the
same XMAP file the SMAP will be loaded.
No. Copy Number Profiles was validated to run on a remote server with R 2.14.1 or
greater installed.
It is recommended that “Human” be run on a remote cluster running Sun Grid Engine.
Please see the Irys Site Preparation guide for recommend cluster configurations.
You can import an SV file into IrysView using the File->Import->SV->Add in the
Comparisons->Data tab. This will place an entry into the associated *_r.cmap file of the
loaded .xmap file. In the Comparisons->Analysis tab use the File->Import->Smap option
to import the SV into the loaded .xmap file. Note that in the Comparisons->Data tab the
updated file is the associated *_r.cmap whilst the Comparisons->Analysis tab the
updated file is the *.xmap file.
Will applying Unfiltered Molecules disable the Length, Label count and Filter
Intensity filters?
No. Unfiltered Molecules will display the data from the RawMolecules.bnx file instead of
Molecules.bnx.
No. Please set the permissions to allow other users to create files in the folder and
subfolders of the directory that contains the data. To speed up the transfer time and the
number of files being transferred, IrysView compresses the files on the server in the
folder(s) where the data resides; therefore it is recommended that not more than one
person transfer the data at any given time.
Using dual label color BNX data requires the user to swap the color channels as
IrysView currently displays alignments using channel 1 only.
You can use the right-click menu option on the data set in the Runs tab to swap the color
channels and automatically load the resulting BNX file back into IrysView. Optionally you
can use the option under the Tools menu to swap the color channels and then you can
manually load the resulting BNX file back into IrysView.
The following images show the results before and after swapping the channel colors:
Before swap (use color 1)
Running a job on the server from with IrysView and then changing workspace can
cause data to be downloaded into the newly opened workspace
Starting a job with IrysView and then changing workspace can cause the download of
the finished job into the workspace that is currently open in IrysView. To prevent this
from happening, it is recommended that you close IrysView and then reopen IrysView
and then navigate to the workspace. The closing of IrysView closes all threads
associated with IrysView.
Aneuploidy table is empty when I selected to view Copy Number (CN) from the
menu.
Do the following if the Aneuploidy grid does not populate in the Comparisons->Data tab
after selecting the CN button:
Exporting
A comparison (.xmap) must be loaded into the Comparisons-Data tab before exporting
can proceed. Note that the data displayed in the Data tab is what will be exported
regardless of the current comparison map highlighted.
Hovering on labels in Anchor does not highlight molecules in Multi Sample Level
View
In Multi Sample Level View, if you have molecules displayed, and you hover the mouse
over the labels in the Reference track, the molecules do not highlight. The workaround is
to hover the mouse on the labels of the query.
Scrolling of queries leaves ghost lines for the samples associated with the reference that
has been moved.