55
66<!-- badges: start -->
77
8- [ ![ Travis build
9- status] ( https://travis-ci.org/data-edu/dataedu.svg?branch=master )] ( https://travis-ci.org/data-edu/dataedu )
10- [ ![ AppVeyor build
11- status] ( https://ci.appveyor.com/api/projects/status/github/ivelasq/dataedu?branch=master&svg=true )] ( https://ci.appveyor.com/project/ivelasq/dataedu )
128[ ![ Codecov test
139coverage] ( https://codecov.io/gh/data-edu/dataedu/branch/master/graph/badge.svg )] ( https://codecov.io/gh/data-edu/dataedu?branch=master )
1410[ ![ minimal R
1511version] ( https://img.shields.io/badge/R%3E%3D-3.6-6666ff.svg )] ( https://cran.r-project.org/ )
16- [ ![ Last-changedate] ( https://img.shields.io/badge/last%20change-2020--06--28-yellowgreen.svg )] ( https://github.com/data-edu/dataedu/commits/master )
12+ [ ![ Last-changedate] ( https://img.shields.io/badge/last%20change-2025--03--29-yellowgreen.svg )] ( https://github.com/data-edu/dataedu/commits/master )
13+ [ ![ R-CMD-check] ( https://github.com/data-edu/dataedu/actions/workflows/R-CMD-check.yaml/badge.svg )] ( https://github.com/data-edu/dataedu/actions/workflows/R-CMD-check.yaml )
14+ [ ![ Codecov test
15+ coverage] ( https://codecov.io/gh/data-edu/dataedu/graph/badge.svg )] ( https://app.codecov.io/gh/data-edu/dataedu )
1716<!-- badges: end -->
1817
1918The goal of {dataedu} is to provide readers of [ Data Science in
2019Education Using
2120R] ( https://github.com/data-edu/data-science-in-education ) with a package
2221with useful functions, data, and references from the book.
2322
24- - [ Installation] ( #installation )
25- - [ Package Contents] ( #package-contents )
26- - [ Contact] ( #contact )
23+ - [ Installation] ( #installation )
24+ - [ Package Contents] ( #package-contents )
25+ - [ Contact] ( #contact )
2726
2827## Installation
2928
30- ### 1\ . Install {remotes }
29+ ### 1. Install {pak }
3130
32- First, let’s install {remotes }. If you already have {remotes } installed,
33- you can move on to the next step.
31+ First, let’s install {pak }. If you already have {pak } installed, you can
32+ move on to the next step.
3433
3534``` r
36- install.packages(" remotes " )
35+ install.packages(" pak " )
3736```
3837
39- ### 2\ . Install {dataedu}
38+ ### 2. Install {dataedu}
4039
4140You can install the development version of {dataedu} by running this in
4241your RStudio console:
4342
4443``` r
45- remotes :: install_github (" data-edu/dataedu" )
44+ pak :: pak (" data-edu/dataedu" )
4645```
4746
4847#### Important Notes on Installation
4948
50- - {dataedu} requires R 3.6 or above to be installed.
49+ - {dataedu} requires R 3.6 or above to be installed.
5150
52- - {dataedu} has other packages that it needs to be able to run. You
53- can see the full list under “Imports” (imported when downloading the
54- package) and “Suggests” (we think you should include these too\ ! ) in
55- the [ DESCRIPTION
56- file] ( https://github.com/data-edu/dataedu/blob/master/DESCRIPTION#L34 ) .
51+ - {dataedu} has other packages that it needs to be able to run. You can
52+ see the full list under “Imports” (imported when downloading the
53+ package) and “Suggests” (we think you should include these too!) in
54+ the [ DESCRIPTION
55+ file] ( https://github.com/data-edu/dataedu/blob/master/DESCRIPTION#L34 ) .
5756
58- - ** We recommend first checking to see if your packages are all
59- up-to-date if you are running into issues with installation.** If
60- you have installed the imported/suggested packages previously and
61- have not updated them in a while, RStudio may prompt you to update
62- them. You can choose to (1) ignore this prompt, (2) exit the prompt
63- and update your packages, or (3) try to update your packages through
64- the prompt. It’s usually easier to exit and update your packages
65- outside the prompt (one way to do this is to go to the RStudio
66- Packages pane and click Update, then select the packages you’d like
67- to update).
57+ - ** We recommend first checking to see if your packages are all
58+ up-to-date if you are running into issues with installation.** If you
59+ have installed the imported/suggested packages previously and have not
60+ updated them in a while, RStudio may prompt you to update them. You
61+ can choose to (1) ignore this prompt, (2) exit the prompt and update
62+ your packages, or (3) try to update your packages through the prompt.
63+ It’s usually easier to exit and update your packages outside the
64+ prompt (one way to do this is to go to the RStudio Packages pane and
65+ click Update, then select the packages you’d like to update).
6866
69- ### 3\ . Call the Package
67+ ### 3. Call the Package
7068
7169Before you can use the package, make sure to call it using ` library() ` :
7270
@@ -92,7 +90,7 @@ into R however they see fit.
9290
9391We strived to use packages that we use in our daily work when creating
9492the walkthroughs in the book. Because we covered a variety of subjects,
95- that means we used a lot of packages\ ! As described in the Foundational
93+ that means we used a lot of packages! As described in the Foundational
9694Skills chapter, you can install the packages individually as they suit
9795your needs.
9896
@@ -113,18 +111,14 @@ dataedu::dataedu_packages
113111# > [16] "textdata" "tidygraph" "tidylog" "tidyverse" "tidytext"
114112```
115113
116- ** A special note on {tabulizer }:** One of the walkthroughs uses
117- [ tabulizer ] ( https://github.com/ ropensci/tabulizer ) , created by ROpenSci
118- to read PDFs. {tabulizer } requires the installation of
114+ ** A special note on {tabulapdf }:** One of the walkthroughs uses
115+ [ tabulapdf ] ( https://docs. ropensci.org/tabulapdf/index.html ) , created by
116+ ROpenSci to read PDFs. {tabulapdf } requires the installation of
119117[ RJava] ( https://cran.r-project.org/web/packages/rJava/index.html ) , which
120- can be a tricky process. {tabulizer } is not included in
118+ can be a tricky process. {tabulapdf } is not included in
121119` install_dataedu() ` and we recommend reading through the notes on its
122120Github repo if installing.
123121
124- ### Reproducible Code for Walkthroughs
125-
126- Coming soon\!
127-
128122### Accessing the Walkthrough Data
129123
130124To get the data, run ` dataedu:: ` then the dataset as it is named in the
@@ -134,8 +128,8 @@ book:
134128dataedu :: course_data
135129```
136130
137- To see all the datasets available in the package, run `data(package =
138- "dataedu")`.
131+ To see all the datasets available in the package, run
132+ ` data(package = "dataedu")` .
139133
140134``` r
141135# this is to print the results for the README
@@ -195,14 +189,12 @@ file would be.
195189Add the theme and palette to ggplot2-based plots using ` theme_dataedu() `
196190and ` scale_*_dataedu() ` .
197191
198- - ** Note:** The DataEdu theme uses {showtext} to render the font. If
199- you would like to use it in an R markdown chunk, please ensure that
200- the chunk lists ` fig.showtext = TRUE ` . If you would like to use it
201- in a standalone R script, then you will need to use a differnet
202- graphic device. More information is available in the documentation
203- [ here] ( https://cran.rstudio.com/web/packages/showtext/vignettes/introduction.html ) .
204-
205- <!-- end list -->
192+ - ** Note:** The DataEdu theme uses {showtext} to render the font. If you
193+ would like to use it in an R markdown chunk, please ensure that the
194+ chunk lists ` fig.showtext = TRUE ` . If you would like to use it in a
195+ standalone R script, then you will need to use a differnet graphic
196+ device. More information is available in the documentation
197+ [ here] ( https://cran.rstudio.com/web/packages/showtext/vignettes/introduction.html ) .
206198
207199``` r
208200library(ggplot2 )
@@ -220,13 +212,13 @@ The font for the DSIEUR graphs is Cabin and available
220212[ here] ( https://fonts.google.com/specimen/Cabin ) . The code to load the
221213font with the package is heavily based on the code from Guangchuang Yu’s
222214[ extrafont] ( https://github.com/GuangchuangYu/emojifont ) package - thank
223- you\ !
215+ you!
224216
225217## Contact
226218
227- - Please report ideas or issues on the [ Issues
228- page] ( https://github.com/data-edu/dataedu/issues ) . If possible, make
229- your post reproducible using the
230- [ {reprex}] ( https://github.com/tidyverse/reprex ) package.
231- - Send any pull requests on the [ Github
232- repository] ( https://github.com/data-edu/dataedu ) .
219+ - Please report ideas or issues on the [ Issues
220+ page] ( https://github.com/data-edu/dataedu/issues ) . If possible, make
221+ your post reproducible using the
222+ [ {reprex}] ( https://github.com/tidyverse/reprex ) package.
223+ - Send any pull requests on the [ Github
224+ repository] ( https://github.com/data-edu/dataedu ) .
0 commit comments