hemlock_big5.big5

def hemlock_big5.big5(*items, version='IPIP-50', page=False, require=False, choice_labels=5, include_instructions=True, shuffle_items=False, record_index=False) [source]

Create a big 5 personality questionnaire.

Parameters: *items :

Names of big 5 items to include. If no items are specified, this function returns all big 5 items in the specified version.

version : str, default='IPIP-50'

Version of the big 5 questionnaire. Currently supported are 'IPIP-50' (50-item version from the Interntaional Personality Item Pool), 'TIPI' (Ten-Item Personality Inventory), and 'BFI-10' (10-item Big 5 Inventory).

page : bool, default=False

Indicates that this function should return a page with the big 5 items. Otherwise, return a list of questions.

require : bool, default=False

Indicates that responses are required (for all items).

choice_labels : int or list, default=5

List of strings for the choice labels participants can select. May also be 5 or 7 for 5 or 7 default labels.

include_instructions : bool, default=True

Indicates that an instructions label should be included before the items.

shuffle_items : bool, default=False

Indicates that items should be shuffled.

record_index : bool, default=False

Indicates to record the index of the big 5 items as they appear on the page. Only applies of page is True.

Returns: big5_questionnaire : hemlock.Page or list of hemlock.Question

If page is True, this function returns a page containing the requested big 5 items. Otherise, it returns a list of questions.

hemlock_big5.big5_traits

def hemlock_big5.big5_traits(*traits, version='IPIP-50', **kwargs) [source]

Create a big 5 personality questionnaire for specified personality traits.

Parameters: *traits :

Strings of requested traits, 'E' for extraversion, 'A' for agreeableness, 'C' for conscientiousness, 'N' for neuroticism, 'O' for openness.

version : str, default='IPIP-50'

Version of the big 5 questionnaire.

**kwargs :

Keyword arguments are passed to big5.

Returns: big5_questionnaire : hemlock.Page or list of hemlock.Question

If page is True, this function returns a page containing the requested big 5 items. Otherise, it returns a list of questions.