Difference between revisions of "README iRefIndex Feedback 2.0"

From irefindex
Line 25: Line 25:
 
| db_name_feedback_v.v.txt.zip||feedback for some database (db_name) for irefindex version v.v
 
| db_name_feedback_v.v.txt.zip||feedback for some database (db_name) for irefindex version v.v
 
|-
 
|-
−
| db_name_not_mapped__v.v.txt.zip||accessions provided by some database (db_name) that were not found for irefindex version v.v
+
| db_name_not_mapped__v.v.txt.zip||accession provided by some database (db_name) that were not found for irefindex version v.v
 
|-
 
|-
 
|}
 
|}
Line 68: Line 68:
 
Columns 4 - 6 describe the ***primary*** reference for the protein as listed in the interaction record.
 
Columns 4 - 6 describe the ***primary*** reference for the protein as listed in the interaction record.
  
−
Columns 7 - 9 describe the reference in the interaction record that was ***used*** by the irefindex process to locate a current protein sequence record.  In many (most) cases, this will be the same as coumns 4 - 6 unless the primary reference could not be found and one of the secondary references supplied in the interaction record was used.
+
Columns 7 - 9 describe the protein reference in the interaction record that was ***used*** by the irefindex process to locate a current protein sequence record.  In many (most) cases, this will be the same as coumns 4 - 6 unless the primary reference could not be found and one of the secondary references supplied in the interaction record was used.
  
 
Columns 10 - 12 describe the protein reference that the used reference was ***mapped*** to. In most cases, this will be the same as the reference that was used to do the mapping (columns 7 - 9) unless the used reference had to be updated or was an entrez gene id.
 
Columns 10 - 12 describe the protein reference that the used reference was ***mapped*** to. In most cases, this will be the same as the reference that was used to do the mapping (columns 7 - 9) unless the used reference had to be updated or was an entrez gene id.
Line 76: Line 76:
 
Column 14 lists the rogscore (see PMID 18823568 and below) that describes operations performed during the mapping (such as updating identifiers or converting a gene identifier to a protein accession).
 
Column 14 lists the rogscore (see PMID 18823568 and below) that describes operations performed during the mapping (such as updating identifiers or converting a gene identifier to a protein accession).
  
−
Column 15 lists the score_type.  Rogscores (column 14) are grouped into one of six different score_types that indicate the severity of the operations required to perform the mapping.  So, for instance, a score_type of one indeicates a non-problematic mapping whereas a score_type of 6 indicates that the protein reference supplied in the interaction record could not be found and the rog assignment was based on sequence of the protein provided in the interaction record.
+
Column 15 lists the score_type (see PMID 18823568 and below).  Rogscores (column 14) are grouped into one of six different score_types that indicate the severity of the operations required to perform the mapping.  So, for instance, a score_type of one indicates a non-problematic mapping whereas a score_type of 6 indicates that the protein reference supplied in the interaction record could not be found and the rog assignment was based on the sequence of the protein provided in the interaction record.
  
−
A number of protein references could not be found in our current database of proteins and no sequence was provided in the interaction record.  These protein references are listed in the dbname_not_mapped_v.v.txt.zip file for each database.
+
A number of protein references could not be found in our current database of proteins and no sequence was provided in the interaction record.  These protein references are listed in the dbname_not_mapped_v.v.txt.zip file for each database.
  
  
  
−
 
−
{| {{table}}
 
−
| align="center" style="background:#f0f0f0;"|'''Score'''
 
−
| align="center" style="background:#f0f0f0;"|'''Description of feature'''
 
−
|-
 
−
| P||The interaction record\'s primary (P) reference for the protein was used to make the assignment.
 
−
|-
 
−
| ||
 
−
|-
 
−
| D||The source database (D) listed in the interaction record is different than what is expected for the given accession for the protein. In specific cases, this difference is tolerated and the assignment is made.
 
−
|-
 
−
| ||
 
−
|-
 
−
| T||The taxonomy (T) identifier for the protein (as supplied by the interaction record) differed from what was found in the protein sequence record. This discrepancy was tolerated and the assignment was made.
 
−
|-
 
−
| ||
 
−
|-
 
−
| M||The protein reference listed by the interaction record was a typographical modification (M) of a known accession. In specific cases, this variation is tolerated and the assignment is made.
 
−
|-
 
−
| ||
 
−
|-
 
−
| V||The protein reference listed by the interaction record contained version (V) information that was ignored. For example, RefSeq accession.version NP_012420.1 was listed but treated as RefSeq accession NP_012420.
 
−
|-
 
−
| ||
 
−
|-
 
−
| Q||The protein reference used to make the assignment was of the type \"see-also\". See PSI-MI Path: entrySet/entry/interactorList/interactor/xref/primaryRef/refType = \"see-also\".
 
−
|-
 
−
| ||
 
−
|-
 
−
| U||The protein reference listed in the interaction record and used to make the assignment was a secondary UniProt accession and was updated (U) to a primary UniProt accession in order to make the assignment.
 
−
|-
 
−
| ||
 
−
|-
 
−
| E||The protein reference was a retired NCBI Identifier. NCBI\'s eUtils (E) were used to retrieve the current accession and/or sequence.
 
−
|-
 
−
| ||
 
−
|-
 
−
| I||The protein reference used was an NCBI GenInfo Identifier (I).
 
−
|-
 
−
| ||
 
−
|-
 
−
| G||The interaction record\'s reference for the protein was an EntrezGene (G) identifier. The corresponding products of the gene were used to make the assignment.
 
−
|-
 
−
| ||
 
−
|-
 
−
| S||One of the interaction record\'s secondary (S) references for the protein was used to make the assignment.
 
−
|-
 
−
| ||
 
−
|-
 
−
| +||More than one possible assignment is possible (+). This case may arise in one of three ways. 1) The reference supplied by the interaction record requires updating but more than one possibility exists. For example, Q7XJL8 was found to be a secondary accession in three separate UniProt records (Q3EBZ2, Q6DR20, and Q8GWA9). 2) The secondary references supplied by the interaction record point to more than one unique protein sequence. 3) An EntrezGene identifier is provided in the interaction record as a protein reference. This identifier points to more than one protein product. An attempt is made to resolve this ambiguity as indicated by ROG score features O, X or L (see below).
 
−
|-
 
−
| ||
 
−
|-
 
−
| O||More than one possible assignment is possible (see + above). The assignment chosen has a SEGUID that is identical to the SEGUID of the original (O) sequence provided in the interaction record.
 
−
|-
 
−
| ||
 
−
|-
 
−
| X||More than one possible assignment is possible (see + above). The assignment chosen has the same taxonomy (X) identifier as listed in the interaction record.
 
−
|-
 
−
| ||
 
−
|-
 
−
| L||More than one possible assignment is possible (see + above). The assignment with the largest (L) SEGUID is arbitrarily chosen (see Methods).
 
−
|-
 
−
| ||
 
−
|-
 
−
| N||The protein reference, taxonomy identifier and sequence for the protein as provided in the interaction record are used to make a new entry in the SEGUID table. The protein interactor is assigned the newly (N) generated ROG identifier.
 
−
|-
 
−
| ||
 
−
|-
 
−
|
 
−
|}
 
  
 
== Description of Feedback file ==
 
== Description of Feedback file ==
Line 415: Line 344:
  
 
See iRefIndex paper. PMID 18823568.  
 
See iRefIndex paper. PMID 18823568.  
 +
 +
The table below is a legend of the characters used in the rogscore (column 14).
 +
 +
{| {{table}}
 +
| align="center" style="background:#f0f0f0;"|'''Score'''
 +
| align="center" style="background:#f0f0f0;"|'''Description of feature'''
 +
|-
 +
| P||The interaction record\'s primary (P) reference for the protein was used to make the assignment.
 +
|-
 +
| ||
 +
|-
 +
| D||The source database (D) listed in the interaction record is different than what is expected for the given accession for the protein. In specific cases, this difference is tolerated and the assignment is made.
 +
|-
 +
| ||
 +
|-
 +
| T||The taxonomy (T) identifier for the protein (as supplied by the interaction record) differed from what was found in the protein sequence record. This discrepancy was tolerated and the assignment was made.
 +
|-
 +
| ||
 +
|-
 +
| M||The protein reference listed by the interaction record was a typographical modification (M) of a known accession. In specific cases, this variation is tolerated and the assignment is made.
 +
|-
 +
| ||
 +
|-
 +
| V||The protein reference listed by the interaction record contained version (V) information that was ignored. For example, RefSeq accession.version NP_012420.1 was listed but treated as RefSeq accession NP_012420.
 +
|-
 +
| ||
 +
|-
 +
| Q||The protein reference used to make the assignment was of the type \"see-also\". See PSI-MI Path: entrySet/entry/interactorList/interactor/xref/primaryRef/refType = \"see-also\".
 +
|-
 +
| ||
 +
|-
 +
| U||The protein reference listed in the interaction record and used to make the assignment was a secondary UniProt accession and was updated (U) to a primary UniProt accession in order to make the assignment.
 +
|-
 +
| ||
 +
|-
 +
| E||The protein reference was a retired NCBI Identifier. NCBI\'s eUtils (E) were used to retrieve the current accession and/or sequence.
 +
|-
 +
| ||
 +
|-
 +
| I||The protein reference used was an NCBI GenInfo Identifier (I).
 +
|-
 +
| ||
 +
|-
 +
| G||The interaction record\'s reference for the protein was an EntrezGene (G) identifier. The corresponding products of the gene were used to make the assignment.
 +
|-
 +
| ||
 +
|-
 +
| S||One of the interaction record\'s secondary (S) references for the protein was used to make the assignment.
 +
|-
 +
| ||
 +
|-
 +
| +||More than one possible assignment is possible (+). This case may arise in one of three ways. 1) The reference supplied by the interaction record requires updating but more than one possibility exists. For example, Q7XJL8 was found to be a secondary accession in three separate UniProt records (Q3EBZ2, Q6DR20, and Q8GWA9). 2) The secondary references supplied by the interaction record point to more than one unique protein sequence. 3) An EntrezGene identifier is provided in the interaction record as a protein reference. This identifier points to more than one protein product. An attempt is made to resolve this ambiguity as indicated by ROG score features O, X or L (see below).
 +
|-
 +
| ||
 +
|-
 +
| O||More than one possible assignment is possible (see + above). The assignment chosen has a SEGUID that is identical to the SEGUID of the original (O) sequence provided in the interaction record.
 +
|-
 +
| ||
 +
|-
 +
| X||More than one possible assignment is possible (see + above). The assignment chosen has the same taxonomy (X) identifier as listed in the interaction record.
 +
|-
 +
| ||
 +
|-
 +
| L||More than one possible assignment is possible (see + above). The assignment with the largest (L) SEGUID is arbitrarily chosen (see Methods).
 +
|-
 +
| ||
 +
|-
 +
| N||The protein reference, taxonomy identifier and sequence for the protein as provided in the interaction record are used to make a new entry in the SEGUID table. The protein interactor is assigned the newly (N) generated ROG identifier.
 +
|-
 +
| ||
 +
|-
 +
|
 +
|}
  
 
=== Column number: 15 ===
 
=== Column number: 15 ===

Revision as of 01:12, 17 January 2009

Last edited: , January 17th, 2009 Applies to iRefIndex release: 2.0 beta.

Release date: January 13th, 2009

Authors: Ian Donaldson and Sabry Razick

Database: iRefIndex (http://irefindex.uio.no)

Organization: Biotechnology Centre of Oslo, University of Oslo (http://www.biotek.uio.no/)

Description

This file describes the contents of the ftp://ftp.no.embnet.org/irefindex/feedback/ directory and the format of the tab-delimited text files contained within.

Directory contents

File name Description of file
README Pointer to this page
db_name_feedback_v.v.txt.zip feedback for some database (db_name) for irefindex version v.v
db_name_not_mapped__v.v.txt.zip accession provided by some database (db_name) that were not found for irefindex version v.v


Changes from last version

None. First release of this file.

Known Issues

None.

License

This directory is intended for source databases incorporated by the irefindex. These data are released under the Creative Commons Attribution License http://creativecommons.org/licenses/by/2.5/. This means that you are free to use, modify and redistribute these data for personal or commercial use so long as you provide appropriate credit. See next section.

Copyright © 2009 Ian Donaldson

Citation

Razick, S., Magklaras, G., Donaldson, IM. iRefIndex: A consolidated protein interaction database with provenance. BMC Bioinformatics. 2008. 9(1):405. PMID 18823568.

Disclaimer

Data is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Understanding the Feedback files

The feedback file consists of 15 columns. Each line in this file represents 

  1. a reference to a protein interactor found in some source db record and
  2. the iRefIndex mapping to a current protein sequence record.

The first three columns point to an interaction record where the protein reference was found.

Columns 4 - 6 describe the ***primary*** reference for the protein as listed in the interaction record.

Columns 7 - 9 describe the protein reference in the interaction record that was ***used*** by the irefindex process to locate a current protein sequence record. In many (most) cases, this will be the same as coumns 4 - 6 unless the primary reference could not be found and one of the secondary references supplied in the interaction record was used.

Columns 10 - 12 describe the protein reference that the used reference was ***mapped*** to. In most cases, this will be the same as the reference that was used to do the mapping (columns 7 - 9) unless the used reference had to be updated or was an entrez gene id.

Column 13 lists the rogid (see PMID 18823568) of the mapped protein.

Column 14 lists the rogscore (see PMID 18823568 and below) that describes operations performed during the mapping (such as updating identifiers or converting a gene identifier to a protein accession).

Column 15 lists the score_type (see PMID 18823568 and below). Rogscores (column 14) are grouped into one of six different score_types that indicate the severity of the operations required to perform the mapping. So, for instance, a score_type of one indicates a non-problematic mapping whereas a score_type of 6 indicates that the protein reference supplied in the interaction record could not be found and the rog assignment was based on the sequence of the protein provided in the interaction record.

A number of protein references could not be found in our current database of proteins and no sequence was provided in the interaction record. These protein references are listed in the dbname_not_mapped_v.v.txt.zip file for each database.



Description of Feedback file

Each line in this file represents

  1. a protein interactor found in some source db record and
  2. the iRefIndex mapping to a current protein sequence record.

Column number: 1

      • I moved the db to first column and acc to the second column (sabry), I think it is better to tell where the interaction was located, all though the file name tells this. Further when there is no interactions identifier (-10) it does not look good.
Column name: int_db
Column type: string
Description: name of interaction db
Example: intact

Notes Possible values in this field are:

bind biomolecular interaction network db
biogrid the biogrid db
dip db of interacting proteins
hprd human protein reference db
intact ebi interaction db
mint molecular interaction db
mpact mips yeast protein interaction db
mppi mips mammalian protein interaction db
ophid online predicted human interaction db

Column number: 2

Column name: int_acc
Column type: string
Description: accession for interaction record
Example: intact

Notes


Column number: 3

    • I recommend having this column , this would allow for the sources to locate there files, avoid questions like 'Where did you get this information from '
Column name: source_file
Column type: string
Description: source file of interaction record
Example: pmid_2006_14691232.xml

Notes


Column number: 4

Column name: primary_db
Column type: string
Description: source db for accession listed in column 4
Example: uniprotkb

Notes

This is the primary protein sequence database referenced in the interaction record.

Column number: 5

Column name: primary_acc
Column type: string
Description: An accession for a protein interactor in some database as supplied in the interaction record (see columns 1-2)
Example: Q9Y6Q9

Notes


Column number: 6

Column name: primary_taxid
Column type: integer
Description: taxonomy of protein interactor as listed in the source interaction record
Example: 9606

Notes


Column number: 7

Column name: used_db
Column type: string
Description: source db for accession listed in column 4
Example: uniprotkb

Notes

This is the primary protein sequence database referenced in the interaction record.


Column number: 8

Column name: used_acc
Column type: string
Description: An accession for a protein interactor in some database as supplied in the interaction record (see columns 1-2)
Example: Q9Y6Q9

Notes

Column number: 9

Column name: used_taxid
Column type: integer
Description: taxonomy of protein interactor as listed in the source interaction record
Example: 9606

Notes


Column number: 10

Column name: mapped_db
Column type: string
Description: the source protein db that this interactor was mapped to by iRefIndex
Example: uniprot

Notes

This will most likely be the same as the db listed in column 6 unless:

reason example see scores with...
the db name is not valid or is a variation of a cv db uniprot in place of "protein database" D


Column number: 11

Column name: mapped_acc
Column type: string
Description: the accession that this interactor was mapped to by iRefIndex
Example: Q9Y6Q9

Notes This will most likely be the same accession as listed in column 4 unless:

reason example see scores with...
a modified version of the accession has been used NP_0001 in place of NP 0001 M
an updated version of the accession has been used xxx in place of xxx U or E


Column number: 12

Column name: mapped_taxid
Column type: integer
Description: Taxonomy identifier for interactor as found in source protein db for record specified in column 8 and 9.
Example: 9606

Notes

This will most likely be the same as the taxid listed in column 7 unless:

reason example see scores with...
the listed taxid is different from that found in the mapped record xxx in place of xxx T

Column number: 13

Column name: rogid
Column type: string
Description: rogid of the interactor assigned by iRefIndex
Example: HWcRyNPgZ0dLD9cb5iuiarsGG8E9606

Notes See iRefIndex paper. PMID 18823568.

Column number: 14

Column name: rogscore
Column type: string
Description: description of assignment score for this interactor
Example: PUTO+

Notes

See iRefIndex paper. PMID 18823568.

The table below is a legend of the characters used in the rogscore (column 14).

Score Description of feature
P The interaction record\'s primary (P) reference for the protein was used to make the assignment.
D The source database (D) listed in the interaction record is different than what is expected for the given accession for the protein. In specific cases, this difference is tolerated and the assignment is made.
T The taxonomy (T) identifier for the protein (as supplied by the interaction record) differed from what was found in the protein sequence record. This discrepancy was tolerated and the assignment was made.
M The protein reference listed by the interaction record was a typographical modification (M) of a known accession. In specific cases, this variation is tolerated and the assignment is made.
V The protein reference listed by the interaction record contained version (V) information that was ignored. For example, RefSeq accession.version NP_012420.1 was listed but treated as RefSeq accession NP_012420.
Q The protein reference used to make the assignment was of the type \"see-also\". See PSI-MI Path: entrySet/entry/interactorList/interactor/xref/primaryRef/refType = \"see-also\".
U The protein reference listed in the interaction record and used to make the assignment was a secondary UniProt accession and was updated (U) to a primary UniProt accession in order to make the assignment.
E The protein reference was a retired NCBI Identifier. NCBI\'s eUtils (E) were used to retrieve the current accession and/or sequence.
I The protein reference used was an NCBI GenInfo Identifier (I).
G The interaction record\'s reference for the protein was an EntrezGene (G) identifier. The corresponding products of the gene were used to make the assignment.
S One of the interaction record\'s secondary (S) references for the protein was used to make the assignment.
+ More than one possible assignment is possible (+). This case may arise in one of three ways. 1) The reference supplied by the interaction record requires updating but more than one possibility exists. For example, Q7XJL8 was found to be a secondary accession in three separate UniProt records (Q3EBZ2, Q6DR20, and Q8GWA9). 2) The secondary references supplied by the interaction record point to more than one unique protein sequence. 3) An EntrezGene identifier is provided in the interaction record as a protein reference. This identifier points to more than one protein product. An attempt is made to resolve this ambiguity as indicated by ROG score features O, X or L (see below).
O More than one possible assignment is possible (see + above). The assignment chosen has a SEGUID that is identical to the SEGUID of the original (O) sequence provided in the interaction record.
X More than one possible assignment is possible (see + above). The assignment chosen has the same taxonomy (X) identifier as listed in the interaction record.
L More than one possible assignment is possible (see + above). The assignment with the largest (L) SEGUID is arbitrarily chosen (see Methods).
N The protein reference, taxonomy identifier and sequence for the protein as provided in the interaction record are used to make a new entry in the SEGUID table. The protein interactor is assigned the newly (N) generated ROG identifier.

Column number: 15

Column name: score_type
Column type: integer
Description: assignment score type 1-6
Example: 1

Notes

See iRefIndex paper. PMID 18823568. Table 4 column 1

Not found file

Same format as the feed back file scores are all '-' (need to talk to Ian, Sabry)

Each row in this table represents an interactor reference which we were unable to map to a sequence.

Column number: 1

Column name: int_acc
Column type: string
Description: accession for interaction record
Example: intact

Notes


Column number: 2

Column name: int_db
Column type: string
Description: name of interaction db
Example: intact

Notes Possible values in this field are:

bind biomolecular interaction network db
biogrid the biogrid db
dip db of interacting proteins
hprd human protein reference db
intact ebi interaction db
mint molecular interaction db
mpact mips yeast protein interaction db
mppi mips mammalian protein interaction db
ophid online predicted human interaction db

Column number: 3

Column name: unfound_acc
Column type: string
Description: An accession for a protein interactor in some database as supplied in the interaction record (see columns 1-2)
Example: Q9Y6Q9

Notes


Column number: 4

Column name: unfound_db
Column type: string
Description: source db for accession listed in column 4
Example: uniprotkb

Notes

This is the primary protein sequence database referenced in the interaction record.

Column number: 5

Column name: unfound_taxid
Column type: integer
Description: taxonomy of protein interactor as listed in the source interaction record
Example: 9606

Notes

Retrieved from "http://irefindex.vib.be/wiki/index.php?title=README_iRefIndex_Feedback_2.0&oldid=443"