annotate ogrinfo.xml @ 2:5b2417aa0b62 draft

planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/gdal commit d2c064afb4680f459012473e4de8653079e32c15

<tool id="gdal_ogrinfo" name="OGR Informations" version="@VERSION@">
    <description>lists information about an OGR supported data source</description>
    <macros>
        <import>gdal_macros.xml</import>
    </macros>
    <expand macro="gdal_requirements" />
    <command detect_errors="exit_code"><![CDATA[
    ogrinfo -ro
        #if $input1.is_of_type("shp") 
            ${os.path.join( $input1.extra_files_path, 'shapefile.shp' )} 
        #else
            '$input1' 
        #end if
        -al
        #if $settings.advanced=='advanced'
            #if $settings.condi_sql.sql=='sql':
                #if str($settings.condi_sql.sql_statement).strip()!='':
                    -sql '$settings.condi_sql.sql_statement'
                #end if
            #end if
            $settings.so
        #end if
        > '$output'
    ]]></command>
    <inputs>
        <param type="data" name="input1" format="xml,txt,netcdf,shp" label="Gdal supported vector input file" help="Currently supported format are GeoJSON GML KML, WFS and Shapefile"/>
        <conditional name="settings">
            <expand macro="gdal_advanced_params_select"/>
            <when value="advanced">
                <conditional name="condi_sql">
                    <param name="sql" type="select" label="Use a sql query on the file" help="-sql. Execute the indicated SQL statement and return the result"> 
                        <option value="no_sql" selected="true">Don't use the -sql option</option>
                        <option value="sql">Use the -sql option</option>
                    </param>
                    <when value="no_sql">
                    </when>
                    <when value="sql">
                        <param name="sql_statement" type="text" label="Execute the indicated SQL"  help="-sql statement eg : SELECT * FROM layer WHERE X>10." value="">
                            <sanitizer sanitize="False"/>
                            <validator type="regex" message="Type a valid SQL query">^(?ims)\s*select\s+.*\s+from\s+.*$</validator>
                        </param>
                    </when>
                </conditional>
                <param name="so" label="Summary Only" help="-so. Suppress listing of features, show only the summary information like projection, schema, feature count and extents" type="boolean" truevalue="-so" falsevalue="" checked="true"/>
            </when>
        </conditional>
    </inputs>
    <outputs>
        <data name="output" format="txt" label="OGR Info file on ${on_string}"/>
    </outputs>
    <tests>
        <test>
            <param name="input1" value="custom.geo.json"/>
            <param name="advanced" value="simple"/>
            <output name="output" file="ogrinfo_test1_out2.txt" lines_diff="85"/>
        </test>
        <test>
            <param name="input1" value="shp_compositefiles/shapefile.html" ftype="shp">
                <composite_data value="shp_compositefiles/shapefile.shp"/>
                <composite_data value="shp_compositefiles/shapefile.shx"/>
                <composite_data value="shp_compositefiles/shapefile.dbf"/>
                <composite_data value="shp_compositefiles/shapefile.sbn"/>
                <composite_data value="shp_compositefiles/shapefile.sbx"/>
            </param>
            <param name="advanced" value="simple"/>
            <output name="output" file="ogrinfo_shp.txt" lines_diff="2"/>
        </test>
    </tests>
    <help><![CDATA[
========
Ogrinfo
========

**What it does**

The Ogrinfo program lists various information about an OGR supported vector dataset.

|

**How to use it**

Select from history a suported vector file. 

|

**Advanced options and sources**

To see complete details and help section please check the official gdal sources.

http://www.gdal.org

https://gdal.org/programs/ogrinfo.html

http://download.osgeo.org/gdal/workshop/foss4ge2015/workshop_gdal.pdf
    ]]></help>
    <expand macro="gdal_citation"/>
</tool>