view qiime_metadata_distance-matrix.xml @ 0:09b7bcb72fa7 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 02:11:44 -0400
parents
children
line wrap: on
line source

<?xml version="1.0" ?>
<tool id="qiime_metadata_distance-matrix" name="qiime metadata distance-matrix" version="2018.4">
	<description> - Create a distance matrix from a numeric Metadata column</description>
	<requirements>
		<requirement type="package" version="2018.4">qiime2</requirement>
	</requirements>
	<command>
	<![CDATA[
	qiime metadata distance-matrix --m-metadata-column="$mmetadatacolumn"

	#def list_dict_to_string(list_dict):
		#set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
		#for d in list_dict[1:]:
			#set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
		#end for
		#return $file_list
	#end def

	 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
	#if str($cmdconfig) != 'None':
	 --cmd-config=$cmdconfig
	#end if
	 --o-distance-matrix=odistancematrix;
	cp odistancematrix.qza $odistancematrix;
	]]>
	</command>
	<inputs>
		<repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
			<param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
		</repeat>
		<param label="--m-metadata-column: MetadataColumn[Numeric] Column from metadata file or artifact viewable as metadata. Numeric metadata column to compute pairwise Euclidean distances from  [required]" name="mmetadatacolumn" optional="False" type="text"/>

		<param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
	</inputs>
	<outputs>
		<data format="qza" label="${tool.name} on ${on_string}: distance-matrix.qza" name="odistancematrix"/>
	</outputs>
	<help>
		<![CDATA[
Create a distance matrix from a numeric Metadata column
--------------------------------------------------------

Create a distance matrix from a numeric metadata column. The Euclidean
distance is computed between each pair of samples or features in the
column.  Tip: the distance matrix produced by this method can be used as
input to the Mantel test available in `q2-diversity`.

Parameters
----------
metadata : MetadataColumn[Numeric]
    Numeric metadata column to compute pairwise Euclidean distances from

Returns
-------
distance_matrix : DistanceMatrix
		\
		]]>
	</help>
</tool>