Filters

Filters are a way to sort data as it enters a database. There are 26 filters (A-Z) with Results Index 1-42. Filters can be associated with routines, samples and features. There are three types of filters, Unrestricted, Restricted, and Key Filters.

Unrestricted Filters

An Unrestricted filter gets associated to a feature, sample or routine, and can be used for sorting, but does not determine whether or not the associated data will enter the database. Unrestricted filters do not have a defined set of values.

Restricted Filters

When data is being processed, and it does not match a Restricted filter, it will not go in the database. Restricted filters have a defined set of values.

Key Filters

Key filters are very much like Restricted filters. Data which does not meet the criteria of the key filters will not be put in the database. Key Filters have a defined set of values. A routine does NOT need a value for its key or restricted filters. Blank is always a valid option for key and restricted filters. If a key or restricted filter has a value, it must match one of the options defined in the database.

Filter Definitions

A name, label, type, and value make up a filter's definition. Filter definitions are stored in the database.

Results Index

The results index value maps the filters from the CM4D database to the filter structure in the Results database. The index can be a value from 1-42. An index value can only be used once within a CM4D database. By default, each filter is assigned an index value corresponding to letter position in the alphabet. For example, Filter A has an index of 1, Filter B has an idex of 2, etc.). Filter index values can be modified after the upgrade is complete as needed.

See also, Filter Mapping with CM4D.

Routine Key

The Routine Key is a unique identifier for a routine. The Routine Key consists of the Routine Label, Routine hand, and Routine Key Filters. When routine keys are listed in the tree bar, the routine key is “normalized”. If all of the filter info is the same for every routine, the fields that are identical for all routines are eliminated and not displayed. This technique is also used when listing samples and filters in CM4D. Some routine variables of interest:

~rout,hand~ for Routine hand

~rout,filter,[a-z]~ for Routine filters a-z (e.g. ~rout,filter,a~)

~rout,info,[a-z]~ for Routine filters a-z (e.g. ~rout,info,a~)

~load,features,filters~ returns the filters that were selected for the loaded features.

Normalized Routine Key

Routine Keys can be very long. To save space when a list of routines is displayed, the Routine Key is normalized. Any parts of the Routine Key which are the same in all the members of the list are hidden.