Documentation
Classes
SelectFpr

SelectFpr

Filter: Select the pvalues below alpha based on a FPR test.

FPR test stands for false Positive Rate test. It controls the total amount of false detections.

Read more in the User Guide.

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new SelectFpr(opts?: object): SelectFpr;

Parameters

NameTypeDescription
opts?object-
opts.alpha?numberFeatures with p-values less than alpha are selected. Default Value 0.05
opts.score_func?anyFunction taking two arrays X and y, and returning a pair of arrays (scores, pvalues). Default is f_classif (see below “See Also”). The default function only works with classification tasks.

Returns

SelectFpr

Defined in: generated/feature_selection/SelectFpr.ts:25 (opens in a new tab)

Properties

_isDisposed

boolean = false

Defined in: generated/feature_selection/SelectFpr.ts:23 (opens in a new tab)

_isInitialized

boolean = false

Defined in: generated/feature_selection/SelectFpr.ts:22 (opens in a new tab)

_py

PythonBridge

Defined in: generated/feature_selection/SelectFpr.ts:21 (opens in a new tab)

id

string

Defined in: generated/feature_selection/SelectFpr.ts:18 (opens in a new tab)

opts

any

Defined in: generated/feature_selection/SelectFpr.ts:19 (opens in a new tab)

Accessors

feature_names_in_

Names of features seen during fit. Defined only when X has feature names that are all strings.

Signature

feature_names_in_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/feature_selection/SelectFpr.ts:443 (opens in a new tab)

n_features_in_

Number of features seen during fit.

Signature

n_features_in_(): Promise<number>;

Returns

Promise<number>

Defined in: generated/feature_selection/SelectFpr.ts:418 (opens in a new tab)

pvalues_

p-values of feature scores.

Signature

pvalues_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/feature_selection/SelectFpr.ts:395 (opens in a new tab)

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/feature_selection/SelectFpr.ts:42 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

NameType
pythonBridgePythonBridge

Returns

void

Defined in: generated/feature_selection/SelectFpr.ts:46 (opens in a new tab)

scores_

Scores of features.

Signature

scores_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/feature_selection/SelectFpr.ts:372 (opens in a new tab)

Methods

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/feature_selection/SelectFpr.ts:94 (opens in a new tab)

fit()

Run score function on (X, y) and get the appropriate features.

Signature

fit(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]The training input samples.
opts.y?ArrayLikeThe target values (class labels in classification, real numbers in regression).

Returns

Promise<any>

Defined in: generated/feature_selection/SelectFpr.ts:111 (opens in a new tab)

fit_transform()

Fit to data, then transform it.

Fits transformer to X and y with optional parameters fit\_params and returns a transformed version of X.

Signature

fit_transform(opts: object): Promise<any[]>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Input samples.
opts.fit_params?anyAdditional fit parameters.
opts.y?ArrayLikeTarget values (undefined for unsupervised transformations).

Returns

Promise<any[]>

Defined in: generated/feature_selection/SelectFpr.ts:153 (opens in a new tab)

get_feature_names_out()

Mask feature names according to selected features.

Signature

get_feature_names_out(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.input_features?anyInput features.

Returns

Promise<any>

Defined in: generated/feature_selection/SelectFpr.ts:200 (opens in a new tab)

get_support()

Get a mask, or integer index, of the features selected.

Signature

get_support(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.indices?booleanIf true, the return value will be an array of integers, rather than a boolean mask. Default Value false

Returns

Promise<any>

Defined in: generated/feature_selection/SelectFpr.ts:236 (opens in a new tab)

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

NameType
pyPythonBridge

Returns

Promise<void>

Defined in: generated/feature_selection/SelectFpr.ts:55 (opens in a new tab)

inverse_transform()

Reverse the transformation operation.

Signature

inverse_transform(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.X?anyThe input samples.

Returns

Promise<any>

Defined in: generated/feature_selection/SelectFpr.ts:271 (opens in a new tab)

set_output()

Set output container.

See Introducing the set_output API for an example on how to use the API.

Signature

set_output(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.transform?"default" | "pandas"Configure output of transform and fit\_transform.

Returns

Promise<any>

Defined in: generated/feature_selection/SelectFpr.ts:306 (opens in a new tab)

transform()

Reduce X to the selected features.

Signature

transform(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.X?anyThe input samples.

Returns

Promise<any>

Defined in: generated/feature_selection/SelectFpr.ts:339 (opens in a new tab)