Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

pylipid.api.LipidInteraction.residue

LipidInteraction.residue(residue_id=None, residue_name=None, print_data=True)

Obtain the lipid interaction information for a residue

Use either residue_id or residue_name to indicate the residue identity. Return the interaction information in a pandas.DataFrame object.

Parameters

• residue_id (int or list of int, default=None) – The residue ID that is used by PyLipID for identifying residues. The ID starts from 0, i.e. the ID of N-th residue is (N-1). If None, all residues are selected.

• residue_name (str or list of str, default=None) – The residue name as stored in PyLipID dataset. The residue name is in the format of resi+resn

Returns

df – A pandas.DataFrame of interaction information of the residue.

Return type

pandas.DataFrame