kb_sdk_ontology/ElectronicAnnotationMethods.spec at master · jplfaria/kb_sdk_ontology · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
A KBase module: ElectronicAnnotationMethods
This module wraps the following methods:

  interpro2go          -> InterPro2GO
  ec2go                -> EC2GO
  uniprotkb_keyword2go -> UniProtKB-Keyword2GO

*/

module ElectronicAnnotationMethods {

    /*
        workspace - the name of the workspace for input/output
        input_genome - reference to the input genome object
        ontology_translation - optional reference to user specified ontology translation map
        output_genome - the name of the mapped genome annotation object

        @optional ontology_translation
    */
    typedef structure {
        string workspace;
        string input_genome;
        string ontology_translation;
        string output_genome;
    } ElectronicAnnotationParams;

    typedef structure {
        string report_name;
        string report_ref;
        string output_genome_ref;
        int n_total_features;
        int n_features_mapped;
    } ElectronicAnnotationResults;


    funcdef remap_annotations_with_interpro2go(ElectronicAnnotationParams params) returns (ElectronicAnnotationResults output)
        authentication required;

    funcdef remap_annotations_with_ec2go(ElectronicAnnotationParams params) returns (ElectronicAnnotationResults output)
        authentication required;

    funcdef remap_annotations_with_uniprotkb_keyword2go(ElectronicAnnotationParams params) returns (ElectronicAnnotationResults output)
        authentication required;

};