EVOLUTION-MANAGER
Edit File: desc_add_author_gh.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Add a GitHub user as an author to DESCRIPTION</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for desc_add_author_gh {desc}"><tr><td>desc_add_author_gh {desc}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Add a GitHub user as an author to DESCRIPTION</h2> <h3>Description</h3> <p>Uses the Authors@R field. </p> <h3>Usage</h3> <pre> desc_add_author_gh( username, role = "ctb", comment = NULL, orcid = NULL, file = ".", normalize = FALSE ) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>username</code></td> <td> <p>GitHub username of the GitHub user</p> </td></tr> <tr valign="top"><td><code>role</code></td> <td> <p>Role to set for the user, defaults to contributor.</p> </td></tr> <tr valign="top"><td><code>comment</code></td> <td> <p>Comment, empty by default.</p> </td></tr> <tr valign="top"><td><code>orcid</code></td> <td> <p>ORCID, empty by default.</p> </td></tr> <tr valign="top"><td><code>file</code></td> <td> <p>DESCRIPTION file to use. By default the DESCRIPTION file of the current package (i.e. the package the working directory is part of) is used.</p> </td></tr> <tr valign="top"><td><code>normalize</code></td> <td> <p>Whether to "normalize" (reorder and reformat) the fields when writing back the result. See <code><a href="desc_normalize.html">desc_normalize()</a></code>.</p> </td></tr> </table> <h3>Details</h3> <p><code>desc_add_author_gh</code> is a convenience function, it adds the GitHub user as an author, and it needs the <code>gh</code> package to be installed. The full name is parsed using <code>as.person</code> and collapsing the given name and the family name in order to e.g. have the first and middle names together as given name. This approach might be limited to some full name structures. </p> <h3>See Also</h3> <p>Other Authors@R: <code><a href="desc_add_author.html">desc_add_author</a>()</code>, <code><a href="desc_add_me.html">desc_add_me</a>()</code>, <code><a href="desc_add_orcid.html">desc_add_orcid</a>()</code>, <code><a href="desc_add_role.html">desc_add_role</a>()</code>, <code><a href="desc_change_maintainer.html">desc_change_maintainer</a>()</code>, <code><a href="desc_coerce_authors_at_r.html">desc_coerce_authors_at_r</a>()</code>, <code><a href="desc_del_author.html">desc_del_author</a>()</code>, <code><a href="desc_del_role.html">desc_del_role</a>()</code>, <code><a href="desc_get_authors.html">desc_get_authors</a>()</code>, <code><a href="desc_get_author.html">desc_get_author</a>()</code>, <code><a href="desc_get_maintainer.html">desc_get_maintainer</a>()</code>, <code><a href="desc_set_authors.html">desc_set_authors</a>()</code> </p> <hr /><div style="text-align: center;">[Package <em>desc</em> version 1.4.2 <a href="00Index.html">Index</a>]</div> </body></html>