This component provides a means of getting a high level simple summary of input data. This involves things like the latest or current wavelengths of variables, their descriptions, the originating instrument similar parameters.

Usage

da.summary.general [switches…​] [[station] variables times [archive]|[file]]

Switches

--mode=TYPE

This is the base summary mode. This determines the results output as well as the method of displaying them.

Default: Per-variable summary

The possible values are:

--mode=instrument

Summary output on an instrument

--mode=variable

Summary output on a per-variable basis

--cover[=BOOLEAN]

If set then the summary includes the global coverage percentage of each output.

--data=STRING…​

This sets any additional data paths to include in the final summary output.

--description[=BOOLEAN]

If set then the summary includes the variable description from the metadata.

--display=TYPE

This is the mode used to format and display the final results.

Default: Determined by primary mode

The possible values are:

--display=csv

Comma separated data with the unique identifiers as rows.

--display=csvtranspose

Comma separated data with the unique identifiers as columns.

--display=space

Space separated data with the unique identifiers as rows.

--display=transpose

Space separated data with the unique identifiers as columns.

--instrument[=BOOLEAN]

If set then the summary includes the source instrument from the metadata.

--mean[=BOOLEAN]

If set then the summary includes the global arithmetic mean of each output.

--metadata=STRING…​

This sets any additional metadata paths to include in the final summary output. Because these are looked up from metadata values they will usually begin with a "^" indicating a metadata path.

--rows=TYPE

This is the method that rows are created using. This determines how data are placed into various output binnings.

Default: Determined by primary mode

The possible values are:

--rows=flavorless

Create rows for each station, archive, and variable combination

--rows=instrument

Create a row for each instrument code (e.x. "S11")

--rows=variable

Create rows for each unique station, archive, variable and flavors combination

--stddev[=BOOLEAN]

If set then the summary includes the global standard deviation of each output.

--wavelength[=BOOLEAN]

If set then the summary includes the variable wavelength from the metadata.

Arguments

If no bare word input specification is supplied then data are read from standard input.

station

This argument is used to specify the station used to look up variables that do not include a station as part of an archive read specification. The station is the three letter GAW station code of the location, such as BND. The argument accepts multiple stations specified as regular expressions and separated by : or ; or ,. For example BND,MLO and (BND|MLO) are two ways of selecting both the BND and MLO stations.

The special value allstations may also be specified to select all stations.

variables

This argument may be split into multiple actual program arguments. Each part consists of one or more variable specifications separated by , (commas). The station and archive used if none are explicitly given are defined in the other arguments or inferred from system defaults. For example simply BsB_S11 selects the blue scattering from the S11 instrument and returns all cut sizes and metadata. If instead ::BsB_S11:pm10 is used then only PM10 scattering is returned. That is, the selection specifies "any" station and archive (the defaults are set in the other arguments) then requires that it has the "PM10" flavor. A specification such as bnd:BsB_S11,thd:BsB_S11 allows for data selection from multiple stations.

This may also be used to select a "record" type alias such as "S11a". In this mode all the variables defined in the alias are returned.

Finally the special value everything can be used to select all available data for the given station(s) and archive(s).

times

This argument may be split into multiple actual program arguments. This full list of time arguments defines a time bounds list that sets the range of data queried. The final resulting data are clipped to the given time bounds but any values that intersect them are returned.

archive

This argument is used to specify the archive used to look up variables that do not include an archive as part of an archive read specification. The archive is the internal name, such as raw or clean_meta. The argument accepts multiple archives specified as regular expressions and separated by : or ; or ,. For example raw(_meta)? selects both the raw and raw_meta archives.

The special value allarchives may also be used to select all available archives.

file

This argument is used to specify the the file to read data from. If it is present and exists then data is read from the given file name instead of from standard input. Alternatively - (a single dash) may be used to explicitly specify standard input.

Examples

Space separated columns by variable
da.summary.general bnd S11a 2015-05-01 2015-05-03

Or:

da.summary.general input_file.c3d

Or:

da.get bnd S11a 2015-05-01 2015-05-03 | da.summary.general
Comma separated displaying wavelengths, units and formats
da.summary.general --cover=false --display=csv --mean=false --metadata=^Format,^Units --rows=flavorless --wavelength bnd S11a 2015-05-01 2015-05-03