-
Notifications
You must be signed in to change notification settings - Fork 2
/
shhh-secret-for-later-README.Rmd
65 lines (46 loc) · 2.43 KB
/
shhh-secret-for-later-README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
library(tidyverse)
```
# 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 functions `usethis::use_git()` + `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.
```{r, include = FALSE}
## load data/add-on-packages-freqtable.csv here in this chunk
```
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.
```{r, echo = FALSE}
## print the frequency table here
## make it prettier if you know how
```
![](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()
```
</details>
*See <https://github.com/jennybc/wtf-packages-report-EXAMPLE> for a fully realized example.*