165 lines
9.6 KiB
HTML
165 lines
9.6 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>utils.files.output.format_data — Analyse Morphologique 1.2.0 documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/sphinx_highlight.js"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="utils.files.output.save_output_file" href="utils.files.output.save_output_file.html" />
|
||
<link rel="prev" title="utils.files.output" href="utils.files.output.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
Analyse Morphologique
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="utils.html">utils</a><ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.create_xyz.html">utils.create_xyz</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.data_processing.html">utils.data_processing</a></li>
|
||
<li class="toctree-l3 current"><a class="reference internal" href="utils.files.html">utils.files</a><ul class="current">
|
||
<li class="toctree-l4"><a class="reference internal" href="utils.files.input.html">utils.files.input</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="utils.files.norm.html">utils.files.norm</a></li>
|
||
<li class="toctree-l4 current"><a class="reference internal" href="utils.files.output.html">utils.files.output</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.graph2D.html">utils.graph2D</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.graph3D.html">utils.graph3D</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.gui.html">utils.gui</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.math.html">utils.math</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.settings.html">utils.settings</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">Analyse Morphologique</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="../api.html">API</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.html">utils</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.files.html">utils.files</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.files.output.html">utils.files.output</a></li>
|
||
<li class="breadcrumb-item active">utils.files.output.format_data</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/_autosummary/utils.files.output.format_data.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="utils-files-output-format-data">
|
||
<h1>utils.files.output.format_data<a class="headerlink" href="#utils-files-output-format-data" title="Permalink to this heading"></a></h1>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="utils.files.output.format_data">
|
||
<span class="sig-prename descclassname"><span class="pre">utils.files.output.</span></span><span class="sig-name descname"><span class="pre">format_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected_columns</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#utils.files.output.format_data" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Format the data to be saved in the output file.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>data</strong> – Data to be formatted</p></li>
|
||
<li><p><strong>selected_columns</strong> – Columns to be saved (in the specified order)</p></li>
|
||
<li><p><strong>separator</strong> – Separator of the columns</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Formatted data</p>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>Example:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
||
<span class="gp">... </span> <span class="s1">'col1'</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span>
|
||
<span class="gp">... </span> <span class="s1">'col2'</span><span class="p">:</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">],</span>
|
||
<span class="gp">... </span> <span class="s1">'col3'</span><span class="p">:</span> <span class="p">[</span><span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">]</span>
|
||
<span class="gp">... </span><span class="p">}</span>
|
||
<span class="gp">>>> </span><span class="n">format_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">separator</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||
<span class="go">'col1;col2;col3</span>
|
||
<span class="go"> 1 ;4 ;7</span>
|
||
<span class="go"> 2 ;5 ;8</span>
|
||
<span class="go"> 3 ;6 ;9</span>
|
||
<span class="go">'</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="utils.files.output.html" class="btn btn-neutral float-left" title="utils.files.output" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="utils.files.output.save_output_file.html" class="btn btn-neutral float-right" title="utils.files.output.save_output_file" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, Djalim SIMAILA, Alexis DOGHMANE.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |