~hrbrmstr/epidata

ref: 47b2d52f37909c0b01ad02edd12decb043a1dfb6 epidata/docs/index.html -rw-r--r-- 12.5 KiB
47b2d52fhrbrmstr readme 2 years ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tools to Retrieve Economic Policy Institute Data Library Extracts • epidata</title>
<!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><!-- mathjax --><script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
    <div class="container template-home">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="index.html">epidata</a>
    </div>
    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
<li>
  <a href="reference/index.html">Reference</a>
</li>
<li>
  <a href="news/index.html">News</a>
</li>
      </ul>
<ul class="nav navbar-nav navbar-right">
<li>
  <a href="https://github.com/hrbrmstr/epidata">
    <span class="fa fa-github fa-lg"></span>
     
  </a>
</li>
      </ul>
</div>
<!--/.nav-collapse -->
  </div>
<!--/.container -->
</div>
<!--/.navbar -->

      
      </header><div class="row">
  <div class="contents col-md-9">
    
<p><code>epidata</code> : Tools to Retrieve Economic Policy Institute Data Library Extracts</p>
<p>The <a href="http://www.epi.org/data/">Economic Policy Institute</a> provides researchers, media, and the public with easily accessible, up-to-date, and comprehensive historical data on the American labor force. It is compiled from Economic Policy Institute analysis of government data sources. Use it to research wages, inequality, and other economic indicators over time and among demographic groups. Data is usually updated monthly.</p>
<p>The following functions are implemented:</p>
<ul>
<li>
<code>get_black_white_wage_gap</code>: Retreive the percent by which hourly wages of black workers are less than hourly wages of white workers</li>
<li>
<code>get_college_wage_premium</code>: Retreive the percent by which hourly wages of college graduates exceed those of otherwise equivalent high school graduates</li>
<li>
<code>get_employment_to_population_ratio</code>: Retreive the share of the civilian noninstitutional population that is employed</li>
<li>
<code>get_gender_wage_gap</code>: Retreive the percent by which hourly wages of female workers are less than hourly wages of male workers</li>
<li>
<code>get_hispanic_white_wage_gap</code>: Retreive the percent by which hourly wages of Hispanic workers are less than hourly wages of white workers</li>
<li>
<code>get_labor_force_participation_rate</code>: Retreive the share of the civilian noninstitutional population that is in the labor force</li>
<li>
<code>get_long_term_unemployment</code>: Retreive the share of the labor force that has been unemployed for six months or longer</li>
<li>
<code>get_median_and_mean_wages</code>: Retreive the hourly wage in the middle of the wage distribution</li>
<li>
<code>get_non_high_school_wage_penalty</code>: Retreive the percent by which hourly wages of workers without a high school diploma (or equivalent) are less than wages of otherwise equivalent workers who have graduated from high school</li>
<li>
<code>get_underemployment</code>: Retreive the share of the labor force that is “underemployed”</li>
<li>
<code>get_unemployment</code>: Retreive the share of the labor force without a job</li>
<li>
<code>get_unemployment_by_state</code>: Retreive the share of the labor force without a job (by state)</li>
<li>
<code>get_wages_by_education</code>: Retreive the average hourly wages of workers disaggregated by the highest level of education attained</li>
<li>
<code>get_wages_by_percentile</code>: Retreive wages at ten distinct points in the wage distribution</li>
<li>
<code>get_wage_ratios</code>: Retreive the level of inequality within the hourly wage distribution.</li>
</ul>
<div id="installation" class="section level3">
<h3 class="hasAnchor">
<a href="#installation" class="anchor"> </a>Installation</h3>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">devtools::<span class="kw">install_github</span>(<span class="st">"hrbrmstr/epidata"</span>)</code></pre></div>
</div>
<div id="usage" class="section level3">
<h3 class="hasAnchor">
<a href="#usage" class="anchor"> </a>Usage</h3>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">library</span>(epidata)

<span class="co"># current verison</span>
<span class="kw">packageVersion</span>(<span class="st">"epidata"</span>)</code></pre></div>
<div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">## [1] '0.1.0'</code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw"><a href="reference/get_black_white_wage_gap.html">get_black_white_wage_gap</a></span>()</code></pre></div>
<div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">## # A tibble: 43 × 8
##     date white_median white_average black_median black_average gap_median gap_average gap_regression_based
##    &lt;int&gt;        &lt;dbl&gt;         &lt;dbl&gt;        &lt;dbl&gt;         &lt;dbl&gt;      &lt;dbl&gt;       &lt;dbl&gt;                &lt;dbl&gt;
## 1   1973        17.19         19.68        13.50         15.43      0.215       0.216                0.124
## 2   1974        16.73         19.22        13.34         15.19      0.203       0.210                0.105
## 3   1975        16.54         19.23        13.43         15.14      0.188       0.213                0.107
## 4   1976        16.73         19.39        13.45         15.74      0.196       0.188                0.089
## 5   1977        16.71         19.33        13.41         15.51      0.198       0.197                0.095
## 6   1978        16.72         19.43        13.38         15.72      0.200       0.191                0.092
## 7   1979        16.88         19.64        13.85         16.09      0.180       0.181                0.090
## 8   1980        16.58         19.23        13.50         15.73      0.185       0.182                0.092
## 9   1981        16.22         19.10        13.33         15.64      0.178       0.181                0.087
## 10  1982        16.47         19.26        13.17         15.45      0.200       0.198                0.103
## # ... with 33 more rows</code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw"><a href="reference/get_underemployment.html">get_underemployment</a></span>()</code></pre></div>
<div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">## # A tibble: 416 × 2
##          date   all
##        &lt;date&gt; &lt;dbl&gt;
## 1  1989-12-01 0.093
## 2  1990-01-01 0.093
## 3  1990-02-01 0.093
## 4  1990-03-01 0.094
## 5  1990-04-01 0.094
## 6  1990-05-01 0.094
## 7  1990-06-01 0.094
## 8  1990-07-01 0.094
## 9  1990-08-01 0.095
## 10 1990-09-01 0.095
## # ... with 406 more rows</code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw"><a href="reference/get_median_and_mean_wages.html">get_median_and_mean_wages</a></span>(<span class="st">"gr"</span>)</code></pre></div>
<div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">## # A tibble: 43 × 25
##     date median average men_median men_average women_median women_average white_median white_average black_median
##    &lt;int&gt;  &lt;dbl&gt;   &lt;dbl&gt;      &lt;dbl&gt;       &lt;dbl&gt;        &lt;dbl&gt;         &lt;dbl&gt;        &lt;dbl&gt;         &lt;dbl&gt;        &lt;dbl&gt;
## 1   1973  16.53   19.05      19.89       22.32        12.47         14.30        17.19         19.68        13.50
## 2   1974  16.17   18.67      19.63       21.89        12.39         14.04        16.73         19.22        13.34
## 3   1975  16.05   18.64      19.76       21.81        12.43         14.14        16.54         19.23        13.43
## 4   1976  16.15   18.87      19.41       22.05        12.56         14.53        16.73         19.39        13.45
## 5   1977  16.07   18.77      19.84       22.05        12.51         14.36        16.71         19.33        13.41
## 6   1978  16.36   18.83      20.04       22.18        12.56         14.44        16.72         19.43        13.38
## 7   1979  16.15   19.06      20.30       22.46        12.66         14.63        16.88         19.64        13.85
## 8   1980  16.07   18.66      19.98       22.00        12.60         14.46        16.58         19.23        13.50
## 9   1981  15.66   18.52      19.52       21.82        12.53         14.44        16.22         19.10        13.33
## 10  1982  15.75   18.65      19.30       21.96        12.61         14.68        16.47         19.26        13.17
## # ... with 33 more rows, and 15 more variables: black_average &lt;dbl&gt;, hispanic_median &lt;dbl&gt;, hispanic_average &lt;dbl&gt;,
## #   white_men_median &lt;dbl&gt;, white_men_average &lt;dbl&gt;, black_men_median &lt;dbl&gt;, black_men_average &lt;dbl&gt;,
## #   hispanic_men_median &lt;dbl&gt;, hispanic_men_average &lt;dbl&gt;, white_women_median &lt;dbl&gt;, white_women_average &lt;dbl&gt;,
## #   black_women_median &lt;dbl&gt;, black_women_average &lt;dbl&gt;, hispanic_women_median &lt;dbl&gt;, hispanic_women_average &lt;dbl&gt;</code></pre></div>
</div>
<div id="test-results" class="section level3">
<h3 class="hasAnchor">
<a href="#test-results" class="anchor"> </a>Test Results</h3>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">library</span>(epidata)
<span class="kw">library</span>(testthat)

<span class="kw">date</span>()</code></pre></div>
<div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">## [1] "Wed Jan  4 16:25:14 2017"</code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">test_dir</span>(<span class="st">"tests/"</span>)</code></pre></div>
<div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">## testthat results ========================================================================================================
## OK: 0 SKIPPED: 1 FAILED: 0
## 
## DONE ===================================================================================================================</code></pre></div>
</div>

  </div>

  <div class="col-md-3" id="sidebar">
    <h2>Links</h2>
<ul class="list-unstyled">
<li>Browse source code at <br><a href="https://github.com/hrbrmstr/epidata">https://​github.com/​hrbrmstr/​epidata</a>
</li>
<li>Report a bug at <br><a href="https://github.com/hrbrmstr/epidata/issues">https://​github.com/​hrbrmstr/​epidata/​issues</a>
</li>
</ul>
<h2>License</h2>
<p>AGPL</p>
<h2>Developers</h2>
<ul class="list-unstyled">
<li>Bob Rudis <br><small class="roles"> Author, maintainer </small> </li>
</ul>
</div>
</div>


      <footer><div class="copyright">
  <p>Developed by Bob Rudis.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
</div>

      </footer>
</div>

  </body>
</html>