Skip to content

Commit

Permalink
Add session info and GitHub pages to the secret bonus part
Browse files Browse the repository at this point in the history
  • Loading branch information
@jennybc
jennybc committed Jan 14, 2019
1 parent 699e5e3 commit 13c7d31
Show file tree
Hide file tree
Showing 2 changed files with 170 additions and 10 deletions.
35 changes: 25 additions & 10 deletions shhh-secret-for-later-README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ library(tidyverse)

# packages-report

## Workshop challenge checklist
## Bonus activity prompt

*As you complete tasks, you can ~~cross them out~~ by surrounding with `~~`.*

* Have a look around the files here. Where are the R scripts? What are the directories `data` and `figs` for?
* Notice that this README is an `.Rmd` file. That means it could contain R code and will need to be rendered to create `README.md`.
* Open [R/01_write-installed-packages.R](R/01_write-installed-packages.R). Write the script as directed. Run it. Commit and push the current state.
* Open [R/02_wrangle-packages.R](R/02_wrangle-packages.R). Fill in the missing pieces of the script as directed. Run it. Commit and push the current state.
* Open [R/03_barchart-packages-built.R](R/03_barchart-packages-built.R). Fill in the missing pieces of the script as directed. Run it. Commit and push the current state.
* Fill in the blanks below in this README, using the results stored elsewhere.
* If you get this far, write an R script to run the whole analysis and, perhaps, another script that does a `make clean` style reset.
* Combine your work analyzing your R packages and what we've learned re: GitHub and R Markdown
* This `README.Rmd` gives a scaffold for using the work you did earlier to make a little report.
* Given our previous work, I'm using pre-computed results and including a pre-made figure, leaving the R code down in scripts below `R/`. But know that, in other contexts, you could inline all that code in chunks here. Depends on downstream usage and the project context.
* Locally, do `README.Rmd` --> `README.md` with the "Knit" button or via `rmarkdown::render("README.Rmd")`. Commit both.
* I presume you are hooked up to GitHub remote repo, covered in [Existing project, GitHub last](https://happygitwithr.com/existing-github-last.html). Summary:
- Consider the convenience function `usethis::use_github()`. Or to do by hand:
- Create a similarly-named repo on GitHub.
- Add it to the local repo as the `origin` remote: `git remote add origin https://github.com/YOU/REPO.git`.
- Push and cement the branch tracking relationship: `git push --set-upstream origin master`.
* Push! Now your README is an excellent welcome mat and summary of your project.
* On GitHub, in *Settings*, turn on GitHub Pages. Visit the given URL for an even more polished report of your project. It may take a few minutes to show up / update. Record that as the URL for your repo.

## Overview

Expand All @@ -48,3 +50,16 @@ Here's how they break down in terms of which version of R they were built under,
### Flow of the analysis

*If you have time, document the analysis works, using internal links.*

*If you created some sort of controller script, describe that here.*

<details>

<summary>Session info</summary>
```{r}
devtools::session_info()
```

</details>

*See <https://github.com/jennybc/wtf-packages-report-EXAMPLE> for a fully realized example.*
145 changes: 145 additions & 0 deletions shhh-secret-for-later-README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# packages-report

## Bonus activity prompt

- Combine your work analyzing your R packages and what we’ve learned
re: GitHub and R Markdown
- This `README.Rmd` gives a scaffold for using the work you did
earlier to make a little report.
- Given our previous work, I’m using pre-computed results and
including a pre-made figure, leaving the R code down in scripts
below `R/`. But know that, in other contexts, you could inline all
that code in chunks here. Depends on downstream usage and the
project context.
- Locally, do `README.Rmd` –\> `README.md` with the “Knit” button or
via `rmarkdown::render("README.Rmd")`. Commit both.
- I presume you are hooked up to GitHub remote repo, covered in
[Existing project, GitHub
last](https://happygitwithr.com/existing-github-last.html). Summary:
- Consider the convenience function `usethis::use_github()`. Or to
do by hand:
- Create a similarly-named repo on GitHub.
- Add it to the local repo as the `origin` remote: `git remote add
origin https://github.com/YOU/REPO.git`.
- Push and cement the branch tracking relationship: `git push
--set-upstream origin master`.
- Push\! Now your README is an excellent welcome mat and summary of
your project.
- On GitHub, in *Settings*, turn on GitHub Pages. Visit the given URL
for an even more polished report of your project. It may take a few
minutes to show up / update. Record that as the URL for your repo.

## Overview

The goal of packages-report is to FINISH THIS SENTENCE.

I have `FILL THIS IN!!!` add-on packages installed.

Here’s how they break down in terms of which version of R they were
built under, which is related to how recently they were updated on CRAN.

![](figs/built-barchart.png)

### Flow of the analysis

*If you have time, document the analysis works, using internal links.*

*If you created some sort of controller script, describe that here.*

<details>

<summary>Session info</summary>

``` r
devtools::session_info()
#> ─ Session info ──────────────────────────────────────────────────────────
#> setting value
#> version R version 3.5.2 (2018-12-20)
#> os macOS Mojave 10.14.2
#> system x86_64, darwin15.6.0
#> ui X11
#> language (EN)
#> collate en_CA.UTF-8
#> ctype en_CA.UTF-8
#> tz America/Chicago
#> date 2019-01-14
#>
#> ─ Packages ──────────────────────────────────────────────────────────────
#> package * version date lib source
#> assertthat 0.2.0 2017-04-11 [1] CRAN (R 3.5.0)
#> backports 1.1.3 2018-12-14 [1] CRAN (R 3.5.0)
#> broom 0.5.0 2018-07-17 [1] CRAN (R 3.5.0)
#> callr 3.1.1 2018-12-21 [1] CRAN (R 3.5.0)
#> cellranger 1.1.0 2016-07-27 [1] CRAN (R 3.5.0)
#> cli 1.0.1 2018-09-25 [1] CRAN (R 3.5.0)
#> colorspace 1.3-2 2016-12-14 [1] CRAN (R 3.5.0)
#> crayon 1.3.4 2017-09-16 [1] CRAN (R 3.5.0)
#> desc 1.2.0 2018-05-01 [1] CRAN (R 3.5.0)
#> devtools 2.0.1 2018-10-26 [1] CRAN (R 3.5.2)
#> digest 0.6.18 2018-10-10 [1] CRAN (R 3.5.0)
#> dplyr * 0.8.0.9000 2019-01-09 [1] Github (tidyverse/dplyr@4b69c7d)
#> evaluate 0.12 2018-10-09 [1] CRAN (R 3.5.0)
#> forcats * 0.3.0 2018-02-19 [1] CRAN (R 3.5.0)
#> fs 1.2.6 2018-08-23 [1] CRAN (R 3.5.0)
#> ggplot2 * 3.1.0 2018-10-25 [1] CRAN (R 3.5.1)
#> glue 1.3.0 2018-07-17 [1] CRAN (R 3.5.0)
#> gtable 0.2.0 2016-02-26 [1] CRAN (R 3.5.0)
#> haven 1.1.2 2018-06-27 [1] CRAN (R 3.5.0)
#> hms 0.4.2 2018-03-10 [1] CRAN (R 3.5.0)
#> htmltools 0.3.6 2017-04-28 [1] CRAN (R 3.5.0)
#> httr 1.4.0 2018-12-11 [1] CRAN (R 3.5.0)
#> jsonlite 1.6 2018-12-07 [1] CRAN (R 3.5.0)
#> knitr 1.21 2018-12-10 [1] CRAN (R 3.5.2)
#> lattice 0.20-38 2018-11-04 [2] CRAN (R 3.5.2)
#> lazyeval 0.2.1 2017-10-29 [1] CRAN (R 3.5.0)
#> lubridate 1.7.4 2018-04-11 [1] CRAN (R 3.5.0)
#> magrittr 1.5 2014-11-22 [1] CRAN (R 3.5.0)
#> memoise 1.1.0 2017-04-21 [1] CRAN (R 3.5.0)
#> modelr 0.1.2 2018-05-11 [1] CRAN (R 3.5.0)
#> munsell 0.5.0 2018-06-12 [1] CRAN (R 3.5.0)
#> nlme 3.1-137 2018-04-07 [2] CRAN (R 3.5.2)
#> pillar 1.3.1 2018-12-15 [1] CRAN (R 3.5.0)
#> pkgbuild 1.0.2.9000 2018-12-06 [1] Github (r-lib/pkgbuild@6e4ebdf)
#> pkgconfig 2.0.2 2018-08-16 [1] CRAN (R 3.5.0)
#> pkgload 1.0.2 2018-10-29 [1] CRAN (R 3.5.0)
#> plyr 1.8.4 2016-06-08 [1] CRAN (R 3.5.0)
#> prettyunits 1.0.2 2015-07-13 [1] CRAN (R 3.5.0)
#> processx 3.2.1 2018-12-05 [1] CRAN (R 3.5.0)
#> ps 1.2.1 2018-11-06 [1] CRAN (R 3.5.1)
#> purrr * 0.2.5 2018-05-29 [1] CRAN (R 3.5.0)
#> R6 2.3.0 2018-10-04 [1] CRAN (R 3.5.0)
#> Rcpp 1.0.0 2018-11-07 [1] CRAN (R 3.5.0)
#> readr * 1.3.1 2018-12-21 [1] CRAN (R 3.5.1)
#> readxl 1.2.0 2018-12-19 [1] CRAN (R 3.5.0)
#> remotes 2.0.2.9000 2018-12-19 [1] Github (r-lib/remotes@80c9288)
#> rlang 0.3.1 2019-01-08 [1] CRAN (R 3.5.2)
#> rmarkdown 1.11 2018-12-08 [1] CRAN (R 3.5.0)
#> rprojroot 1.3-2 2018-01-03 [1] CRAN (R 3.5.0)
#> rstudioapi 0.9.0 2019-01-09 [1] CRAN (R 3.5.2)
#> rvest 0.3.2 2016-06-17 [1] CRAN (R 3.5.0)
#> scales 1.0.0 2018-08-09 [1] CRAN (R 3.5.0)
#> sessioninfo 1.1.1 2018-11-05 [1] CRAN (R 3.5.1)
#> stringi 1.2.4 2018-07-20 [1] CRAN (R 3.5.0)
#> stringr * 1.3.1 2018-05-10 [1] CRAN (R 3.5.0)
#> testthat 2.0.1 2018-10-13 [1] CRAN (R 3.5.0)
#> tibble * 2.0.0 2019-01-04 [1] CRAN (R 3.5.2)
#> tidyr * 0.8.2 2018-10-28 [1] CRAN (R 3.5.0)
#> tidyselect 0.2.5 2018-10-11 [1] CRAN (R 3.5.0)
#> tidyverse * 1.2.1 2017-11-14 [1] CRAN (R 3.5.0)
#> usethis 1.4.0.9000 2018-12-20 [1] local
#> withr 2.1.2 2018-03-15 [1] CRAN (R 3.5.0)
#> xfun 0.4 2018-10-23 [1] CRAN (R 3.5.0)
#> xml2 1.2.0 2018-01-24 [1] CRAN (R 3.5.0)
#> yaml 2.2.0 2018-07-25 [1] CRAN (R 3.5.0)
#>
#> [1] /Users/jenny/resources/R/library
#> [2] /Library/Frameworks/R.framework/Versions/3.5/Resources/library
```

</details>

*See <https://github.com/jennybc/wtf-packages-report-EXAMPLE> for a
fully realized example.*

0 comments on commit 13c7d31

Please sign in to comment.