<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Import mouse-tracking data saved in long format. — mt_import_long • mousetrap</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Import mouse-tracking data saved in long format. — mt_import_long"><meta property="og:description" content="mt_import_long receives a data.frame in which mouse-tracking data are
stored in long format, i.e., where one row contains the logging data
(timestamp, x- and y-position etc.) at one specific point in the trial. This
is, for example, the case when exporting the trajectory data from the
mousetrap package using mt_export_long. From this data.frame,
mt_import_long creates a mousetrap data object containing the
trajectories and additional data for further processing within the mousetrap
package. Specifically, it returns a list that includes the trajectory data as
an array (called trajectories), and all other data as a data.frame
(called data). This data structure can then be passed on to other
functions within this package (see mousetrap for an overview)."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">mousetrap</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">3.2.3</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../reference/mousetrap-package.html">Overview</a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li>
  <a href="../news/index.html">News</a>
</li>
      </ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="https://github.com/pascalkieslich/mousetrap" class="external-link">
    <span class="fa fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Import mouse-tracking data saved in long format.</h1>
    <small class="dont-index">Source: <a href="https://github.com/pascalkieslich/mousetrap/blob/HEAD/R/import.R" class="external-link"><code>R/import.R</code></a></small>
    <div class="hidden name"><code>mt_import_long.Rd</code></div>
    </div>

    <div class="ref-description">
    <p><code>mt_import_long</code> receives a data.frame in which mouse-tracking data are
stored in long format, i.e., where one row contains the logging data
(timestamp, x- and y-position etc.) at one specific point in the trial. This
is, for example, the case when exporting the trajectory data from the
mousetrap package using <a href="mt_export_long.html">mt_export_long</a>. From this data.frame,
<code>mt_import_long</code> creates a mousetrap data object containing the
trajectories and additional data for further processing within the mousetrap
package. Specifically, it returns a list that includes the trajectory data as
an array (called <code>trajectories</code>), and all other data as a data.frame
(called <code>data</code>). This data structure can then be passed on to other
functions within this package (see <a href="mousetrap-package.html">mousetrap</a> for an overview).</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">mt_import_long</span><span class="op">(</span></span>
<span>  <span class="va">raw_data</span>,</span>
<span>  xpos_label <span class="op">=</span> <span class="st">"xpos"</span>,</span>
<span>  ypos_label <span class="op">=</span> <span class="st">"ypos"</span>,</span>
<span>  zpos_label <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  timestamps_label <span class="op">=</span> <span class="st">"timestamps"</span>,</span>
<span>  add_labels <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  mt_id_label <span class="op">=</span> <span class="st">"mt_id"</span>,</span>
<span>  mt_seq_label <span class="op">=</span> <span class="st">"mt_seq"</span>,</span>
<span>  reset_timestamps <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  verbose <span class="op">=</span> <span class="cn">TRUE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>raw_data</dt>
<dd><p>a data.frame in long format, containing the raw data.</p></dd>


<dt>xpos_label</dt>
<dd><p>a character string specifying the column containing the
x-positions.</p></dd>


<dt>ypos_label</dt>
<dd><p>a character string specifying the column containing the
y-positions.</p></dd>


<dt>zpos_label</dt>
<dd><p>an optional character string specifying the column
containing the z-positions.</p></dd>


<dt>timestamps_label</dt>
<dd><p>a character string specifying the column containing
the timestamps. If no timestamps are found in the data, a timestamps
variable with increasing integers will be created (assuming equidistant
time steps).</p></dd>


<dt>add_labels</dt>
<dd><p>a character vector specifying columns containing additional
mouse-tracking variables.</p></dd>


<dt>mt_id_label</dt>
<dd><p>a character string (or vector) specifying the name of the
column that provides a unique ID for every trial (the trial identifier). If
more than one variable name is provided, a new ID variable will be created
by combining the values of each variable. The trial identifier will be set
as the <a href="https://rdrr.io/r/base/colnames.html" class="external-link">rownames</a> of the resulting trajectories and trial data, and
additionally be stored in the column "mt_id" in the trial data.</p></dd>


<dt>mt_seq_label</dt>
<dd><p>a character string specifying the column that indicates
the order of the logged coordinates within a trial. If no column of the
specified name is found in the data.frame, the coordinates will be imported
in the order in which they were stored in <code>raw_data</code>.</p></dd>


<dt>reset_timestamps</dt>
<dd><p>logical indicating if the first timestamp should be
subtracted from all timestamps within a trial. Default is <code>TRUE</code> as it
is recommended for all following analyses in mousetrap.</p></dd>


<dt>verbose</dt>
<dd><p>logical indicating whether function should report its
progress.</p></dd>

</dl></div>
    <div id="value">
    <h2>Value</h2>
    

<p>A mousetrap data object (see <a href="mt_example.html">mt_example</a>).</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>The default arguments are set so that no adjustments have to be made when
importing a data.frame that was created using <a href="mt_export_long.html">mt_export_long</a>.</p>
<p>The coordinates are ordered according to the values in the column provided in
the <code>mt_seq_label</code> parameter (<code>mt_seq</code> by default). If the
corresponding column does not exist, the coordinates will be imported in the
order in which they were stored in the raw_data.</p>
<p>If no timestamps are found in the data, <code>mt_import_long</code> automatically
creates a timestamps variable with increasing integers (starting with 0)
assuming equally spaced sampling intervals.</p>
    </div>
    <div id="see-also">
    <h2>See also</h2>
    <div class="dont-index"><p><a href="mt_import_mousetrap.html">mt_import_mousetrap</a> and <a href="mt_import_wide.html">mt_import_wide</a> for importing
mouse-tracking data in other formats.</p></div>
    </div>
    <div id="author">
    <h2>Author</h2>
    <p>Pascal J. Kieslich</p>
<p>Felix Henninger</p>
    </div>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Create data in long format for test purposes</span></span></span>
<span class="r-in"><span><span class="va">mt_data_long</span> <span class="op">&lt;-</span> <span class="fu"><a href="mt_export_long.html">mt_export_long</a></span><span class="op">(</span><span class="va">mt_example</span>,</span></span>
<span class="r-in"><span>  use2_variables<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"subject_nr"</span>,<span class="st">"Condition"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Import the data using mt_import_long</span></span></span>
<span class="r-in"><span><span class="va">mt_data</span> <span class="op">&lt;-</span> <span class="fu">mt_import_long</span><span class="op">(</span><span class="va">mt_data_long</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span>
<span class="r-in"><span><span class="co"># Import a hypothetical dataset that contains the</span></span></span>
<span class="r-in"><span><span class="co"># custom mouse-tracking variables angle and velocity</span></span></span>
<span class="r-in"><span><span class="va">mt_data</span> <span class="op">&lt;-</span> <span class="fu">mt_import_long</span><span class="op">(</span><span class="va">exp_data</span>,</span></span>
<span class="r-in"><span>  add_labels<span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"angle"</span>, <span class="st">"velocity"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </div>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by Pascal J. Kieslich, Dirk U. Wulff, Felix Henninger, Jonas M. B. Haslbeck.</p>
</div>

<div class="pkgdown">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>

      </footer></div>

  


  

  </body></html>

