shared-params

Reused parameter definitions are gathered here for easier editing.

internal

'TidyTuesday' is a project by the 'Data Science Learning
Community' in which they post a weekly dataset in a public data
repository (<https://github.com/rfordatascience/tidytuesday>) for
people to analyze and visualize. This package provides the tools to
easily download this data and the description of the source.

Jon Harmon

tidytuesdayR

Access the Weekly 'TidyTuesday' Project Dataset

Ellis Hughes

Thomas Mock

Data Science Learning Community 

shared-params function

<dl><dt>auth</dt>
<dd>A GitHub token. See <code><a href="https://gh.r-lib.org/reference/gh_token.html">gh::gh_token()</a></code> for more details.</dd>
<dt>files</dt>
<dd>Which file names to download. Default "All" downloads all files
for the specified week.</dd>
<dt>path</dt>
<dd>The relative path to the directory to hold your submission files
(<code>tt_submission</code> by default). If this directory does not exist, it will be
created.</dd>
<dt>tt</dt>
<dd>A <code>tt</code> object, output from <code>tt_load_gh()</code>.</dd>
<dt>week</dt>
<dd>Which week number to use within a given year. Only used when <code>x</code>
is a valid year.</dd>
<dt>x</dt>
<dd>The date of data to pull (in "YYYY-MM-dd" format), or the four-digit
year as a number.</dd>
<dt>year</dt>
<dd>What year of TidyTuesday to use</dd></dl>

Arguments

Parameters used in multiple functions — shared-params

<dl>

<dt>auth</dt>
<dd>A GitHub token. See <code><a href='https://gh.r-lib.org/reference/gh_token.html'>gh::gh_token()</a></code> for more details.</dd>


<dt>files</dt>
<dd>Which file names to download. Default "All" downloads all files
for the specified week.</dd>


<dt>path</dt>
<dd>The relative path to the directory to hold your submission files
(<code>tt_submission</code> by default). If this directory does not exist, it will be
created.</dd>


<dt>tt</dt>
<dd>A <code>tt</code> object, output from <code>tt_load_gh()</code>.</dd>


<dt>week</dt>
<dd>Which week number to use within a given year. Only used when <code>x</code>
is a valid year.</dd>


<dt>x</dt>
<dd>The date of data to pull (in "YYYY-MM-dd" format), or the four-digit
year as a number.</dd>


<dt>year</dt>
<dd>What year of TidyTuesday to use</dd>

</dl>

shared-params: Parameters used in multiple functions

Description

Arguments