class_session: Zoom Class Session Summary

In Lightbridge-KS/readzoom: Zoom Class

Zoom Class Session Summary

Description

class_session() was designed to retrieve time information about each student's session in Zoom's classroom at given time period. Input of this function (data) is a zoom_participants object as returned by read_participants().

Usage

class_session(
  data,
  class_start = NULL,
  class_end = NULL,
  arrange_by = c("Join_Time", "Name", "None"),
  arrange_group = c("Name-Email", "Session", "None"),
  period_to = c("period", "second", "minute", "hour"),
  round_digits = NULL
)

Arguments

data	A data frame (tibble) with class zoom_participants
class_start	(Character) The time of class started, input as "hh:mm:ss" or "hh:mm". If NULL (default) and zoom_participants has meeting_overview attribute, "Start_Time" of the attribute will be used.
class_end	(Character) The time of class ended, input as "hh:mm:ss" or "hh:mm". If NULL (default) and zoom_participants has meeting_overview attribute, "End_Time" of the attribute will be used.
arrange_by	(Character) How to arrange rows, must be one of: "Join_Time": arrange by Join_Time, earliest first "Name": arrange by Name (Original Name) "None": no arrange, preserve rows as original Zoom's participant file
arrange_group	(Character) Indicate group of arrange_by will be affected. "Name-Email": group by Name (Original Name) and Email "Session": group by Session "None": no grouping variable
period_to	(Character) Indicate the units of "Before_Class", "During_Class", "After_Class" and "Total_Time" in the output. Must be one of: "period" (default): return as lubridate::period object "second": return as seconds (numeric) "minute": return as minute (numeric) "hour": return as hour (numeric)
round_digits	(Integer) significant digits to round the numeric columns. If NULL (default), no round.

Details

By providing time of class started (class_start) and ended (class_end), this function will compute time spent before, during, and after class of each sessions. If each student joined the classroom using multiple device, TRUE will be placed in the "Multi_Device" column of the output.

The output will displayed one row per session of each student. (e.g., If student "A" joined more than one time, there will be multiple rows of "A"). Finally, rows will be arranged as specified by arrange_by with grouping by arrange_group.

Value

A data frame (tibble) with class zoom_class. It has the following columns:

• "Name (Original Name)": the same column "Name (Original Name)" as input file

• "Name": Current name displayed in Zoom meeting of the participants.

• "Name_Original": Original name of the participants. It was extracted from the contents within the last balanced parentheses of "Name (Original Name)".

• "Email": from original "User Email" column

• "Session": Indicate active session(s) in Zoom of each students. Computed by ranking "Join_Time" in the grouping variables: "Name (Original Name)" and "Email".

• "Class_Start" (POSIXct): Compute from date of "Join_Time" with time specified by class_start argument.

• "Class_End" (POSIXct): Compute from date of "Leave_Time" with time specified by class_end argument.

• "Join_Time": from the original "Join Time" column

• "Leave_Time": from the original "Leave Time" column

• "Before_Class": Time spent before class_start of each session.

• "During_Class": Time spent during class (between class_start and class_end) of each session.

• "After_Class": Time spent after class_end of each session.

• "Total_Time": "Before_Class" + "During_Class" + "After_Class"

• "Duration_Minutes": from original "Duration (Minutes)" column

• "Rec_Consent": from the original "Recording Consent" column

• "Multi_Device": TRUE if any sessions of each student joined Zoom with multiple devices. It is computed by checking whether "Join_Time" and "Leave_Time" was overlapped with other sessions within each students. Otherwise, NA will be returned because there is no way to be certain that students joined with a single device.

See Also

Checkout class_students() for summary of each students.

Lightbridge-KS/readzoom documentation built on April 3, 2022, 5:59 p.m.