Skip to main content

Activity functions

utils.useful_functions.propagate_activity​

Propagate activity takes an activity from a "base user" and copies the information to all other users in the list. New activities will not be created, but the information from the base user's activity will be copied into the activity with the same name in other participants if it exists. This is useful, for example, if you would like to use the dashboard to correct a typo in a survey. You can correct the typo in one user, and then use this function to propagate the change to all other active users in your study.

Args​

  • base_user: (string) the participant id to copy the activity from.
  • activity_name: (string) the name of the activity to copy.
  • parts: (list of strings) the list of participant ids to copy the activity.
  • excluded_tags: (list of strings, default: []) a list of any tags that should not be copied from the base activity to other participants.

Example​

utils.useful_functions.propagate_activity(base_user="U1234567890", activity_name="Sleep Survey", parts=["U11111111", "U22222222"])

utils.useful_functions.get_activity_names​

Match the ActivityEvents to the Activity name / spec.

Args​

  • part_id: (string) the participant id.
  • sample_length: (float, default: -1, unit=days) the number of previous days of data to include. (ex: days_ago=5 means return only data from the last 5 days)
  • end_of_window: (float, default: current time in ms, unit=ms) the timestamp of the end of the window.

Returns​

A dataframe with the ActivityEvent data with additional columns called "name" and "spec".

Example​

utils.useful_functions.get_activity_names("U1234567890")

Output: