YASMEEN converter

From D4Science Wiki
Revision as of 14:45, 26 October 2013 by Fabio.fiorellato (Talk | contribs) (-providerId)

Jump to: navigation, search

"Yet Another Species Matching Execution ENgine" - DWCA to TAF data converter CLI tool

Purposes

Command line

java -jar YASMINE-converter-<version>.jar <options>

You can launch it with the '-h' option to get a report of the available options with their description:

java -jar YASMINE-converter-<version>.jar -h

Will give:

usage:
 -h                  Print this message
 -inFile <arg>       Specify an input file (either a DWCA file or a folder containing an exploded DWCA file content
 -outDir <arg>       Specify the output folder that will contain the .taf files resulting from the conversion of the input DWCA
 -providerId <arg>   Specify the provider ID. This will have impact on the name of the .taf files generated by the conversion,
                     that will be <provider ID>_taxa.taf and <provider ID>_vernacular.taf

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 data command line options

-inFile

Mandatory.

Specifies the input file. This can be either a DWCA file or a folder containing an exploded DWCA file content.

Output data command line options

-providerId

Mandatory.

Specifies the provider ID. This identifier will be used to actually name the TAF files generated by the conversion.

Taxa and vernacular TAF files produced out of the input DWCA will be named as:

and

respectively.

-outDir

Optional.

Specifies the output folder that will contain the TAF files resulting from the conversion of the input DWCA.

When this option is not explicitly set, the output directory is determined as follows:

  • If the input file is a proper DWCA file, the output directory will be created in its same folder and be named 'out'
  • If the input file is a folder containing the exploded files in a DWCA file, the output directory will be created in the input file folder and be named 'out'

Usage examples

Appendix

Download

You can download the YASMEEN converter through one of this URLs:

  • [http:// v1.1.1] ( KB)