gcell.cell.celltype.Celltype.gene_jacobian_summary

gcell.cell.celltype.Celltype.gene_jacobian_summary#

Celltype.gene_jacobian_summary(gene, axis='motif', multiply_input=True, stats='absmean')[source]#

Summarizes the Jacobian for a given gene.

This function calculates the Jacobian for a given gene and summarizes it based on the specified axis. If the axis is “motif”, it concatenates the Jacobian summaries along axis 1 and then sums them. If the axis is “region”, it concatenates the Jacobian summaries along axis 0, groups them by index, chromosome, and start, and then sums the scores.

Parameters:
gene

The gene for which the Jacobian is to be calculated.

axis default: 'motif'

The axis along which to summarize the Jacobian. Defaults to “motif”.

multiply_input default: True

If True, the input is multiplied. Defaults to True.

Returns:

pd.DataFrame: A DataFrame containing the summarized Jacobian.