| <!DOCTYPE html><html><head><title>R: structField</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> |
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.15.3/dist/katex.min.css"> |
| <script type="text/javascript"> |
| const macros = { "\\R": "\\textsf{R}", "\\code": "\\texttt"}; |
| function processMathHTML() { |
| var l = document.getElementsByClassName('reqn'); |
| for (let e of l) { katex.render(e.textContent, e, { throwOnError: false, macros }); } |
| return; |
| }</script> |
| <script defer src="https://cdn.jsdelivr.net/npm/katex@0.15.3/dist/katex.min.js" |
| onload="processMathHTML();"></script> |
| <link rel="stylesheet" type="text/css" href="R.css" /> |
| |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> |
| <script>hljs.initHighlightingOnLoad();</script> |
| </head><body><div class="container"> |
| |
| <table style="width: 100%;"><tr><td>structField {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> |
| |
| <h2>structField</h2> |
| |
| <h3>Description</h3> |
| |
| <p>Create a structField object that contains the metadata for a single field in a schema. |
| </p> |
| |
| |
| <h3>Usage</h3> |
| |
| <pre><code class='language-R'>structField(x, ...) |
| |
| ## S3 method for class 'jobj' |
| structField(x, ...) |
| |
| ## S3 method for class 'character' |
| structField(x, type, nullable = TRUE, ...) |
| </code></pre> |
| |
| |
| <h3>Arguments</h3> |
| |
| <table> |
| <tr style="vertical-align: top;"><td><code>x</code></td> |
| <td> |
| <p>the name of the field.</p> |
| </td></tr> |
| <tr style="vertical-align: top;"><td><code>...</code></td> |
| <td> |
| <p>additional argument(s) passed to the method.</p> |
| </td></tr> |
| <tr style="vertical-align: top;"><td><code>type</code></td> |
| <td> |
| <p>The data type of the field</p> |
| </td></tr> |
| <tr style="vertical-align: top;"><td><code>nullable</code></td> |
| <td> |
| <p>A logical vector indicating whether or not the field is nullable</p> |
| </td></tr> |
| </table> |
| |
| |
| <h3>Value</h3> |
| |
| <p>A structField object. |
| </p> |
| |
| |
| <h3>Note</h3> |
| |
| <p>structField since 1.4.0 |
| </p> |
| |
| |
| <h3>Examples</h3> |
| |
| <pre><code class="r">## Not run: |
| ##D field1 <- structField("a", "integer") |
| ##D field2 <- structField("c", "string") |
| ##D field3 <- structField("avg", "double") |
| ##D schema <- structType(field1, field2, field3) |
| ##D df1 <- gapply(df, list("a", "c"), |
| ##D function(key, x) { y <- data.frame(key, mean(x$b), stringsAsFactors = FALSE) }, |
| ##D schema) |
| ## End(Not run) |
| </code></pre> |
| |
| |
| <hr /><div style="text-align: center;">[Package <em>SparkR</em> version 3.2.2 <a href="00Index.html">Index</a>]</div> |
| </div> |
| </body></html> |
