#!perl
use strict;
use Carp;
#
# This is a SAS Component
#
=head1 complexes_to_roles
Complexes catalyze reactions and are made up of one or more roles. The roles
that make up a complex can be "optional", or not.
This command takes as input a table with a column composed of complex ids and
adds one column (containing a role that is part of the complex). The "optional" field
is not returned, so you do not get back a field indicating whether or not the role is optional.
If you need that information, we recommend that you use
get_relationship_IsTriggeredBy -rel optional -to id
This would tack on both the optional flag and the role.
Example:
complexes_to_roles [arguments] < input > output
The standard input should be a tab-separated table (i.e., each line
is a tab-separated set of fields). Normally, the last field in each
line would contain the identifer. If another column contains the identifier
use
-c N
where N is the column (from 1) that contains the subsystem.
This is a pipe command. The input is taken from the standard input, and the
output is to the standard output.
=head2 Documentation for underlying call
This script is a wrapper for the CDMI-API call complexes_to_roles. It is documented as follows:
$return = $obj->complexes_to_roles($complexes)
=over 4
=item Parameter and return types
=begin html
<pre>
$complexes is a complexes
$return is a reference to a hash where the key is a complexes and the value is a roles
complexes is a reference to a list where each element is a complex
complex is a string
roles is a reference to a list where each element is a role
role is a string
</pre>
=end html
=begin text
$complexes is a complexes
$return is a reference to a hash where the key is a complexes and the value is a roles
complexes is a reference to a list where each element is a complex
complex is a string
roles is a reference to a list where each element is a role
role is a string
=end text
=back
=head2 Command-Line Options
=over 4
=item -c Column
This is used only if the column containing the subsystem is not the last column.
=item -i InputFile [ use InputFile, rather than stdin ]
=back
=head2 Output Format
The standard output is a tab-delimited file. It consists of the input
file with extra columns added.
Input lines that cannot be extended are written to stderr.
=cut
my $usage = "usage: complexes_to_roles [-c column] < input > output";
my $column;
my $input_file;
my $kbO = Bio::KBase::CDMI::CDMIClient->new_for_script('c=i' => \$column,
'i=s' => \$input_file);
if (! $kbO) { print STDERR $usage; exit }
my $ih;
if ($input_file)
{
open $ih, "<", $input_file or die "Cannot open input file $input_file: $!";
}
else
{
$ih = \*STDIN;
}
while (my @tuples = Bio::KBase::Utilities::ScriptThing::GetBatch($ih, undef, $column)) {
my @h = map { $_->[0] } @tuples;
my $h = $kbO->complexes_to_roles(\@h);
for my $tuple (@tuples) {
#
# Process output here and print.
#
my ($id, $line) = @$tuple;
my $v = $h->{$id};
if (! defined($v))
{
print STDERR $line,"\n";
}
elsif (ref($v) eq 'ARRAY')
{
foreach $_ (@$v)
{
print "$line\t$_\n";
}
}
else
{
print "$line\t$v\n";
}
}
}