feature: Merkmale fuer Fenster

Description Usage Arguments Details Value Future See Also

View source: R/feature.R

Description

Fuer eine Menge von Fenstern werden Merkmalsbeschreibungen extrahiert. Hierbei wird zunaechst ein Vorbereitungs- und anschließend ein Extraktionsschritt durchgefuehrt. Die resultierenden Merkmale stellen eine kompakte Repraesentation des Signalverlaufs dar und koennen als Trainingsdaten fuer maschinelles Lernen verwendet werden.

Usage

1
2
3
4
5
6
7
8
9
feature(
  x,
  feat,
  arg_global = TRUE,
  as_df = TRUE,
  as_wide = TRUE,
  .progress = TRUE,
  ...
)

Arguments

x

Liste mit Fenster-Tiqqles (bzw. ein Einzel-Tiqqle), fuer die Merkmale berechnet werden.

feat

Benannte Liste mit den zu berechnenden Merkmalen und den zugehoerigen Argumenten. Siehe Details fuer ausfuehrlichere Erlaeuterungen.

arg_global

Logischer Wert, ob evtl. benoetigte Funktionsargumente global ueber alle Fenster vorberechnet werden oder lokal fuer die Einzelfenster (Default: TRUE, d.h. sie werden global berechnet).

as_df

Logischer Wert, ob Merkmale als Dataframe zurueckgegeben werden oder als Liste (Default: TRUE, d.h. Merkmals-Dataframe wird erzeugt).

as_wide

Logischer Wert, ob Merkmals-Dataframe ggf. im breiten Format zurueckgegeben wird oder im langen Format (Default: TRUE, d.h. Merkmals-Dataframe wird im breiten Format erzeugt).

.progress

Logischer Wert, ob Fortschrittsbalken angezeigt wird.

...

Weitere Argumente, die an Funktion feature_df durchgereicht werden.

Details

Die zu berechnenden Merkmale werden mittels des Arguments feat ausgewaehlt. Dieses erwartet eine benannte Liste mit je einem Eintrag pro Merkmalstyp. Waehrend der Name des Listeneintrags den Namen des zu berechnenden Merkmalstyp angibt (und somit die aufzurufenden Funktionen), beschreibt das Listenelement die hierfuer zu verwendenden Funktionsargumente. Ein Listenelement besteht dabei wiederum aus einer benannten Liste. Der Namen des Eintrags beschreibt den zu setzenden Argumentnamen, der Wert des Eintrags den entsprechenden zu uebergebenden Argumentwert. Falls kein zusaetzlicher Argumentwert existiert oder die Default-Werte verwendet werden sollen, wird hier eine leere Liste list() oder der Wert NULL uebergeben.

Die verfuegbaren Merkmalstypen koennen mit der Hilfsfunktion feature_all aufgelistet werden. Aktuell sind dies:

In den jeweiligen Funktionen sind die verfuegbaren Argumente dokumentiert. Fuer einige Merkmalsberechnungen ist es noetig, im Vorbereitungsschritt gewisse Argumente global vorzuberechnen. Dieses Verhalten kann durch das Argument arg_global gesteuert werden.

Das Ergebnis der Merkmalsberechnung liegt intern als geschachtelte Liste vor. Diese Merkmalsliste beinhaltet fuer jedes Fenster einen Eintrag mit einem Dataframe, der fuer jedes Signal wiederum eine benannte Liste mit den berechneten Merkmale umfasst. Diese Liste kann mittels der Argumente as_df und as_wide in einen Dataframe im passenden Format konvertiert werden.

Value

Liste oder Dataframe mit berechneten Merkmalen.

Future

Da dieser Verarbeitungsschritt u.U. etwas laenger dauern kann, kann hierfuer mittels future::plan eine parallele Verarbeitung zugeschaltet werden. Durch das Argument .progress kann ggf. ein Forschrittsbalken angezeigt werden.

See Also

feature_all, codefeature_df, feature_wide


dnlvgt/rktiq documentation built on Jan. 6, 2020, 10:26 p.m.