Amy/package v2

docs/build/html/_sources/features/index.rst.txt

@@ -32,7 +32,11 @@ Utterance-Level features are calculated *first* in the Toolkit, as many conversa
 
 Conversation-Level Features
 ****************************
-Once utterance-level features are computed, we compute conversation-level features; some of these features represent an aggregation of utterance-level information (for example, the "average level of positivity" in a conversation is simply the mean positivity score for each utterance). Other conversation-level features are constructs that are defined only at the conversation-level, such as the level of "burstiness" in a team's communication patterns.
+
+Base Conversation-Level Features
++++++++++++++++++++++++++++++++++++
+
+The following features are constructs that are defined only at the conversation-level, such as the level of "burstiness" in a team's communication patterns. We call these the "base" conversation-level features, and they can be accessed using a property of the ``FeatureBuilder`` object: ``FeatureBuilder.conv_features_base``.
 
 .. toctree::
    :maxdepth: 1
@@ -46,12 +50,17 @@ Once utterance-level features are computed, we compute conversation-level featur
    within_person_discursive_range
    turn_taking_features
 
+Conversation-Level Aggregates
++++++++++++++++++++++++++++++++++++
+Once utterance-level features are computed, we compute conversation-level features; some of these features represent an aggregation of utterance-level information (for example, the "average level of positivity" in a conversation is simply the mean positivity score for each utterance).
+
+By default, all numeric attributes generated at the utterance (chat) level are aggregated using the functions ``mean``, ``max``, ``min``, and ``stdev``. However, this behavior can be customized, with details in the Worked Example (see :ref:`custom_aggregation`).
+
 Speaker- (User) Level Features
 *********************************
 User-level features generally represent an aggregation of features at the utterance- level (for example, the average number of words spoken *by a particular user*). There is therefore limited speaker-level feature documentation, other than a function used to compute the "network" of other speakers that an individual interacts with in a conversation.
 
-You may reference the :ref:`Speaker (User)-Level Features Page <user_level_features>` for more information.
-
+You may reference the :ref:`Speaker (User)-Level Features Page <user_level_features>` for more information, as well as the details in the Worked Example (see :ref:`custom_aggregation`).
 
 .. toctree::
    :maxdepth: 1

docs/build/html/features/burstiness.html

@@ -52,18 +52,18 @@
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Features: Technical Documentation</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="index.html#utterance-chat-level-features">Utterance- (Chat) Level Features</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="index.html#conversation-level-features">Conversation-Level Features</a><ul class="current">
-<li class="toctree-l3 current"><a class="current reference internal" href="#">burstiness module</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#features.burstiness.burstiness"><code class="docutils literal notranslate"><span class="pre">burstiness()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="#features.burstiness.get_team_burstiness"><code class="docutils literal notranslate"><span class="pre">get_team_burstiness()</span></code></a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index.html#base-conversation-level-features">Base Conversation-Level Features</a><ul class="current">
+<li class="toctree-l4 current"><a class="current reference internal" href="#">burstiness module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="get_all_DD_features.html">get_all_DD_features module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="discursive_diversity.html">discursive_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="get_all_DD_features.html">get_all_DD_features module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="discursive_diversity.html">discursive_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index.html#conversation-level-aggregates">Conversation-Level Aggregates</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>

docs/build/html/features/discursive_diversity.html

@@ -52,19 +52,18 @@
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Features: Technical Documentation</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="index.html#utterance-chat-level-features">Utterance- (Chat) Level Features</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="index.html#conversation-level-features">Conversation-Level Features</a><ul class="current">
-<li class="toctree-l3"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="get_all_DD_features.html">get_all_DD_features module</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">discursive_diversity module</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#features.discursive_diversity.get_DD"><code class="docutils literal notranslate"><span class="pre">get_DD()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="#features.discursive_diversity.get_cosine_similarity"><code class="docutils literal notranslate"><span class="pre">get_cosine_similarity()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="#features.discursive_diversity.get_unique_pairwise_combos"><code class="docutils literal notranslate"><span class="pre">get_unique_pairwise_combos()</span></code></a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index.html#base-conversation-level-features">Base Conversation-Level Features</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="get_all_DD_features.html">get_all_DD_features module</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">discursive_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index.html#conversation-level-aggregates">Conversation-Level Aggregates</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>

docs/build/html/features/get_all_DD_features.html

@@ -52,18 +52,18 @@
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Features: Technical Documentation</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="index.html#utterance-chat-level-features">Utterance- (Chat) Level Features</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="index.html#conversation-level-features">Conversation-Level Features</a><ul class="current">
-<li class="toctree-l3"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">get_all_DD_features module</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#features.get_all_DD_features.conv_to_float_arr"><code class="docutils literal notranslate"><span class="pre">conv_to_float_arr()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="#features.get_all_DD_features.get_DD_features"><code class="docutils literal notranslate"><span class="pre">get_DD_features()</span></code></a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index.html#base-conversation-level-features">Base Conversation-Level Features</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">get_all_DD_features module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="discursive_diversity.html">discursive_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="discursive_diversity.html">discursive_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index.html#conversation-level-aggregates">Conversation-Level Aggregates</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>

docs/build/html/features/index.html

@@ -71,14 +71,18 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#conversation-level-features">Conversation-Level Features</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="get_all_DD_features.html">get_all_DD_features module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="discursive_diversity.html">discursive_diversity module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#base-conversation-level-features">Base Conversation-Level Features</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="information_diversity.html">information_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../utils/gini_coefficient.html">gini_coefficient module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="get_all_DD_features.html">get_all_DD_features module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="discursive_diversity.html">discursive_diversity module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#conversation-level-aggregates">Conversation-Level Aggregates</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#speaker-user-level-features">Speaker- (User) Level Features</a><ul>
@@ -146,7 +150,9 @@ <h2>Utterance- (Chat) Level Features<a class="headerlink" href="#utterance-chat-
 </section>
 <section id="conversation-level-features">
 <h2>Conversation-Level Features<a class="headerlink" href="#conversation-level-features" title="Link to this heading"></a></h2>
-<p>Once utterance-level features are computed, we compute conversation-level features; some of these features represent an aggregation of utterance-level information (for example, the “average level of positivity” in a conversation is simply the mean positivity score for each utterance). Other conversation-level features are constructs that are defined only at the conversation-level, such as the level of “burstiness” in a team’s communication patterns.</p>
+<section id="base-conversation-level-features">
+<h3>Base Conversation-Level Features<a class="headerlink" href="#base-conversation-level-features" title="Link to this heading"></a></h3>
+<p>The following features are constructs that are defined only at the conversation-level, such as the level of “burstiness” in a team’s communication patterns. We call these the “base” conversation-level features, and they can be accessed using a property of the <code class="docutils literal notranslate"><span class="pre">FeatureBuilder</span></code> object: <code class="docutils literal notranslate"><span class="pre">FeatureBuilder.conv_features_base</span></code>.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="burstiness.html">burstiness module</a></li>
@@ -160,10 +166,16 @@ <h2>Conversation-Level Features<a class="headerlink" href="#conversation-level-f
 </ul>
 </div>
 </section>
+<section id="conversation-level-aggregates">
+<h3>Conversation-Level Aggregates<a class="headerlink" href="#conversation-level-aggregates" title="Link to this heading"></a></h3>
+<p>Once utterance-level features are computed, we compute conversation-level features; some of these features represent an aggregation of utterance-level information (for example, the “average level of positivity” in a conversation is simply the mean positivity score for each utterance).</p>
+<p>By default, all numeric attributes generated at the utterance (chat) level are aggregated using the functions <code class="docutils literal notranslate"><span class="pre">mean</span></code>, <code class="docutils literal notranslate"><span class="pre">max</span></code>, <code class="docutils literal notranslate"><span class="pre">min</span></code>, and <code class="docutils literal notranslate"><span class="pre">stdev</span></code>. However, this behavior can be customized, with details in the Worked Example (see <a class="reference internal" href="../examples.html#custom-aggregation"><span class="std std-ref">Custom Aggregation</span></a>).</p>
+</section>
+</section>
 <section id="speaker-user-level-features">
 <h2>Speaker- (User) Level Features<a class="headerlink" href="#speaker-user-level-features" title="Link to this heading"></a></h2>
 <p>User-level features generally represent an aggregation of features at the utterance- level (for example, the average number of words spoken <em>by a particular user</em>). There is therefore limited speaker-level feature documentation, other than a function used to compute the “network” of other speakers that an individual interacts with in a conversation.</p>
-<p>You may reference the <a class="reference internal" href="../utils/calculate_user_level_features.html#user-level-features"><span class="std std-ref">Speaker (User)-Level Features Page</span></a> for more information.</p>
+<p>You may reference the <a class="reference internal" href="../utils/calculate_user_level_features.html#user-level-features"><span class="std std-ref">Speaker (User)-Level Features Page</span></a> for more information, as well as the details in the Worked Example (see <a class="reference internal" href="../examples.html#custom-aggregation"><span class="std std-ref">Custom Aggregation</span></a>).</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="get_user_network.html">get_user_network module</a></li>