Difference between revisions of "YASMEEN matching results merger"

From D4Science Wiki
Jump to: navigation, search
(Created page with ""''Yet Another Species Matching Execution ENvironment''" - matching results merger CLI tool == Purposes == == Command line == java -jar YASMEEN-merger-<version>.jar <options>...")
 
(Command line)
Line 12: Line 12:
  
 
Will give:
 
Will give:
 +
 +
usage:
 +
  -embeddedTemplate <arg>      Optional. Specify an embedded transformation template to apply to the produced output. Value is
 +
                                one among { stripped, simple, csv, csvNoHeader
 +
  -externalTemplateFile <arg>  Optional. Specify an external transformation template (XSLT) to apply to the produced output
 +
  -h                            Print this message
 +
  -inFile <arg>                Specify a path to a file containing YASMEEN matching results in raw XML format. This option can
 +
                                be repeated multiple time on the command line.
 +
  -outFile <arg>                Specify a path to the file that will contain the merged matching results
 +
  -retainMaxCandidates <arg>    Optional. Specify the maximum number of candidates (per input data) that must be retained in the
 +
                                merged matching results. Accepts a positive integer as value.
 +
  -retainMinScore <arg>        Optional. Specify the minimum matching score that candidates must have to be retained in the
 +
                                merged matching results. Accepts a decimal value in the range (0.0 .. 1.0]
  
 
=== General command line options ===
 
=== General command line options ===
Line 18: Line 31:
  
 
This option requires no arguments, and - when set - will print the help message and exit (no parsing will be performed)
 
This option requires no arguments, and - when set - will print the help message and exit (no parsing will be performed)
 +
 +
=== Input file command line options ===
 +
==== -inFile ====
 +
 +
=== Output file command line options ===
 +
==== -outFile ====
 +
 +
=== Filtering command line options ===
 +
==== -retainMinScore ====
 +
==== -retainMaxCandidates ====
 +
 +
=== Transformation options ===
 +
==== -embeddedTemplate ====
 +
==== -externalTemplateFile ====
  
 
== Appendix ==
 
== Appendix ==

Revision as of 17:51, 31 October 2013

"Yet Another Species Matching Execution ENvironment" - matching results merger CLI tool

Purposes

Command line

java -jar YASMEEN-merger-<version>.jar <options>

This CLI tool can be launched with the '-h' option to get a report of the available options:

java -jar YASMEEN-merger-<version>.jar -h

Will give:

usage:
 -embeddedTemplate <arg>       Optional. Specify an embedded transformation template to apply to the produced output. Value is
                               one among { stripped, simple, csv, csvNoHeader
 -externalTemplateFile <arg>   Optional. Specify an external transformation template (XSLT) to apply to the produced output
 -h                            Print this message
 -inFile <arg>                 Specify a path to a file containing YASMEEN matching results in raw XML format. This option can
                               be repeated multiple time on the command line.
 -outFile <arg>                Specify a path to the file that will contain the merged matching results
 -retainMaxCandidates <arg>    Optional. Specify the maximum number of candidates (per input data) that must be retained in the
                               merged matching results. Accepts a positive integer as value.
 -retainMinScore <arg>         Optional. Specify the minimum matching score that candidates must have to be retained in the
                               merged matching results. Accepts a decimal value in the range (0.0 .. 1.0]

General command line options

-h

This option requires no arguments, and - when set - will print the help message and exit (no parsing will be performed)

Input file command line options

-inFile

Output file command line options

-outFile

Filtering command line options

-retainMinScore

-retainMaxCandidates

Transformation options

-embeddedTemplate

-externalTemplateFile

Appendix

Download

You can download the YASMEEN matching results merger with one of this URLs:

Changelog

  • v1.1.1: first working implementation