filtercategoricalcolumn.qmd

---
title: "Filter rows based on categorical column"
author: "Cox Lab"
format: 
  html:
    toc: true
    toc-depth: 4
    toc-expand: false
    number-sections: true
    number-depth: 4
editor: source
date: today
bibliography: references.bib
---

# General

-   **Type:** - Matrix Processing
-   **Heading:** - Filter rows
-   **Source code:** [FilterCategoricalColumn.cs](https://github.com/JurgenCox/perseus-plugins/blob/master/PerseusPluginLib/Filter/FilterCategoricalColumn.cs)

# Brief description

Those rows are kept or removed that have the specified value in the selected categorical column.

After this step, a new matrix is created that contains these values.

```{=html}
<!-- This comment and the line above it must be preserved when editing this file!
The recommended sections are these, but they may be changed on a case by case basis.
===== Detailed description =====
===== Parameters =====
===== Theoretical background =====
===== Examples =====
Make changes only below this line! -->
```
# Parameters

## Column

Selected categorical column the filtering is based on (default: first categorical column of the matrix).

## Values

Rows with the containing values will be kept/discarded depending on the selected "Mode" (default: no values are selected).

## Mode

The rows with the selected values will be kept/discarded depending on the selected "Mode" (default: "Remove matching rows").
If "Remove matching rows" is selected, rows having the values will be removed while all other rows will be kept.
If "Keep matching rows" is selected, the opposite will happen.

## Filter mode

The "Filter mode" defines, whether the input matrix will be reduced ("Reduce matrix" = default) or a new categorical column called "Filter" will be generated containing the categories "Keep" and "Discard" ("Filter mode" = "Add categorical column").

# Parameter window

![](images/filter_rows-filter_rows_based_on_categorical_column-edited.png)