sample_uploader/sample_uploader.spec at master · crockettz/sample_uploader · 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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
A KBase module: sample_uploader
*/

module sample_uploader {

    typedef string sample_id;

    typedef structure {
        string sample_set_ref;

        string sample_file;
        string workspace_name;
        int workspace_id;
        string file_format;
        string description;
        string set_name;
        int header_row_index;
        string name_field;

        string output_format;
        string taxonomy_source;
        int num_otus;
        int incl_seq;
        string otu_prefix;

        int share_within_workspace;
        int prevalidate;
        int incl_input_in_output;
        int ignore_warnings;
        int keep_existing_samples;
    } ImportSampleInputs;

    typedef structure {
        sample_id id;
        string name;
    } sample_info;

    typedef structure {
        list<sample_info> samples;
        string description;
    } SampleSet;

    typedef structure {
        string report_name;
        string report_ref;
        SampleSet sample_set;
        string sample_set_ref;
    } ImportSampleOutputs;

    funcdef import_samples(ImportSampleInputs params) returns (ImportSampleOutputs output) authentication required;

    typedef structure {
        string sample_set_ref;

        list<string> external_ids;
        string workspace_name;
        int workspace_id;
        string description;
        string set_name;

        string output_format;
        string taxonomy_source;
        int num_otus;
        int incl_seq;
        string otu_prefix;

        int share_within_workspace;
        int prevalidate;
        int incl_input_in_output;
    } ImportExternalSampleInputs;

    funcdef import_samples_from_IGSN(ImportExternalSampleInputs params) returns (ImportSampleOutputs output) authentication required;

    funcdef import_samples_from_NCBI(ImportExternalSampleInputs params) returns (ImportSampleOutputs output) authentication required;


    /*
    Generate a customized OTU worksheet using a SampleSet
    input to generate the appropriate columns.
    */

    typedef structure {
        string workspace_name;
        int workspace_id;
        string sample_set_ref;
        string output_name;
        string output_format;
        int num_otus;
        string taxonomy_source;
        int incl_seq;
        string otu_prefix;
    } GenerateOTUSheetParams;

    typedef structure {
        string report_name;
        string report_ref;
    } GenerateOTUSheetOutputs;

    funcdef generate_OTU_sheet(GenerateOTUSheetParams params) returns (GenerateOTUSheetOutputs output) authentication required;

    typedef structure {
        string workspace_name;
        int workspace_id;

        string sample_set_ref;
        list<string> new_users;
        int is_reader;
        int is_writer;
        int is_admin;

        int share_within_workspace;
    } update_sample_set_acls_params;

    typedef structure {
        string status;
    } update_sample_set_acls_output;

    funcdef update_sample_set_acls(update_sample_set_acls_params params) returns (update_sample_set_acls_output output) authentication required;

    /*
        export function for samples
    */

    typedef structure {
        string input_ref;
        string file_format;
    } ExportParams;

    typedef structure {
        string shock_id;
    } ExportOutput;

    funcdef export_samples(ExportParams params) returns (ExportOutput output) authentication required;

    /*
        Create links between samples and other workspace objects.

        currently support:
            KBaseFile.PairedEndLibrary/SingleEndLibrary,
            KBaseAssembly.PairedEndLibrary/SingleEndLibrary,
            KBaseGenomes.Genome
            KBaseMetagenomes.AnnotatedMetagenomeAssembly

    */

    typedef structure {
        string sample_name;
        string obj_ref;
    } ObjsLink;

    typedef structure {
        string workspace_name;
        string workspace_id;
        string sample_set_ref;
        list<ObjsLink> links;
    } LinkObjsParams;

    /*
    input_staging_file_path: tsv or csv file with sample_name and object_name headers
    */
    typedef structure {
        string workspace_name;
        string workspace_id;
        string sample_set_ref;
        string input_staging_file_path;
    } BatchLinkObjsParams;

    typedef structure {
        string report_name;
        string report_ref;
        list<UnspecifiedObject> links;
    } LinkObjsOutput;

    funcdef link_samples(LinkObjsParams params) returns (LinkObjsOutput output) authentication required;

    funcdef batch_link_samples(BatchLinkObjsParams params) returns (LinkObjsOutput output) authentication required;
};