Merge pull request #126 from ipums/document_concat_two_cols

Document column_mappings transform concat_two_cols

Author: riley-harper

docs/_sources/column_mapping_transforms.md.txt

@@ -61,6 +61,25 @@ Maps string → string.
 transforms = [{type = "concat_to_b", value = " "}]
 ```
 
+## concat_two_cols
+
+Concatenate the values from two columns together as strings. This transform takes
+a `column_to_append` attribute, which specifies the name of the column to concatenate
+to the end of the mapped column. To concatenate more than two columns, you can
+use this transform multiple times in a row.
+
+If either of the columns are numerical, they are automatically converted to strings
+before the concatenation.
+
+Maps (string | numerical) → string.
+
+```toml
+# Concatenate two columns to the end of the mapped column.
+transforms = [
+    {type = "concat_two_cols", column_to_append = "statefip"},
+    {type = "concat_two_cols", column_to_append = "county"},
+]
+```
 
 ## lowercase_strip
 

docs/column_mapping_transforms.html

@@ -82,6 +82,23 @@ <h2>concat_to_b<a class="headerlink" href="#concat-to-b" title="Link to this hea
 </pre></div>
 </div>
 </section>
+<section id="concat-two-cols">
+<h2>concat_two_cols<a class="headerlink" href="#concat-two-cols" title="Link to this heading">¶</a></h2>
+<p>Concatenate the values from two columns together as strings. This transform takes
+a <code class="docutils literal notranslate"><span class="pre">column_to_append</span></code> attribute, which specifies the name of the column to concatenate
+to the end of the mapped column. To concatenate more than two columns, you can
+use this transform multiple times in a row.</p>
+<p>If either of the columns are numerical, they are automatically converted to strings
+before the concatenation.</p>
+<p>Maps (string | numerical) → string.</p>
+<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="c1"># Concatenate two columns to the end of the mapped column.</span>
+<span class="n">transforms</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
+<span class="w">    </span><span class="p">{</span><span class="n">type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;concat_two_cols&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">column_to_append</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;statefip&quot;</span><span class="p">},</span>
+<span class="w">    </span><span class="p">{</span><span class="n">type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;concat_two_cols&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">column_to_append</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;county&quot;</span><span class="p">},</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</section>
 <section id="lowercase-strip">
 <h2>lowercase_strip<a class="headerlink" href="#lowercase-strip" title="Link to this heading">¶</a></h2>
 <p>Used in name cleaning. Convert alphabetical characters to lower-case and strip white
@@ -325,6 +342,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="#add-to-a">add_to_a</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#concat-to-a">concat_to_a</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#concat-to-b">concat_to_b</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#concat-two-cols">concat_two_cols</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#lowercase-strip">lowercase_strip</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#rationalize-name-words">rationalize_name_words</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#remove-qmark-hyphen">remove_qmark_hyphen</a></li>

docs/index.html

@@ -94,6 +94,7 @@ <h1>Configuration API<a class="headerlink" href="#configuration-api" title="Link
 <li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#add-to-a">add_to_a</a></li>
 <li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#concat-to-a">concat_to_a</a></li>
 <li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#concat-to-b">concat_to_b</a></li>
+<li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#concat-two-cols">concat_two_cols</a></li>
 <li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#lowercase-strip">lowercase_strip</a></li>
 <li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#rationalize-name-words">rationalize_name_words</a></li>
 <li class="toctree-l2"><a class="reference internal" href="column_mapping_transforms.html#remove-qmark-hyphen">remove_qmark_hyphen</a></li>

docs/searchindex.js

@@ -61,6 +61,25 @@ Maps string → string.
 transforms = [{type = "concat_to_b", value = " "}]
 ```
 
+## concat_two_cols
+
+Concatenate the values from two columns together as strings. This transform takes
+a `column_to_append` attribute, which specifies the name of the column to concatenate
+to the end of the mapped column. To concatenate more than two columns, you can
+use this transform multiple times in a row.
+
+If either of the columns are numerical, they are automatically converted to strings
+before the concatenation.
+
+Maps (string | numerical) → string.
+
+```toml
+# Concatenate two columns to the end of the mapped column.
+transforms = [
+    {type = "concat_two_cols", column_to_append = "statefip"},
+    {type = "concat_two_cols", column_to_append = "county"},
+]
+```
 
 ## lowercase_strip