Skip to content

Commit 22e068a

Browse files
emma-akrongemma-akrong
committed
assignment instructions
1 parent cd95959 commit 22e068a

9 files changed

Lines changed: 204 additions & 4 deletions

File tree

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,7 @@ AssumptionPlotter/.Rproj.user
22

33
AssumptionPlotter/.Rhistory
44
.Rproj.user
5+
6+
AssumptionPlotter/.DS_Store
7+
.DS_Store
8+
.DS_Store

‎AssumptionPlotter/.Rbuildignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
^.*\.Rproj$
22
^\.Rproj\.user$
3+
^vignettes/\.quarto$
4+
^vignettes/*_files$
5+
^\.github$
6+
^README\.Rmd$

‎AssumptionPlotter/.github/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

‎AssumptionPlotter/.github/workflows/R-CMD-check.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
8+
name: R-CMD-check.yaml
9+
10+
permissions: read-all
11+
12+
jobs:
13+
R-CMD-check:
14+
runs-on: ${{ matrix.config.os }}
15+
16+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
17+
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
config:
22+
- {os: macos-latest, r: 'release'}
23+
- {os: windows-latest, r: 'release'}
24+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
25+
- {os: ubuntu-latest, r: 'release'}
26+
- {os: ubuntu-latest, r: 'oldrel-1'}
27+
28+
env:
29+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
30+
R_KEEP_PKG_SOURCE: yes
31+
32+
steps:
33+
- uses: actions/checkout@v6
34+
35+
- uses: r-lib/actions/setup-pandoc@v2
36+
37+
- uses: r-lib/actions/setup-r@v2
38+
with:
39+
r-version: ${{ matrix.config.r }}
40+
http-user-agent: ${{ matrix.config.http-user-agent }}
41+
42+
- uses: r-lib/actions/setup-r-dependencies@v2
43+
with:
44+
extra-packages: any::rcmdcheck
45+
needs: check
46+
47+
- uses: r-lib/actions/check-r-package@v2
48+
with:
49+
upload-snapshots: true
50+
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

‎AssumptionPlotter/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
inst/doc
2+
**/.quarto/

‎AssumptionPlotter/DESCRIPTION‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: AssumptionPlotter
22
Type: Package
3-
Title: What the Package Does
3+
Title: Assumption Plotter
44
Version: 0.1.0
55
Authors@R: c(
66
person(
@@ -17,8 +17,11 @@ License:
1717
Encoding: UTF-8
1818
LazyData: true
1919
RoxygenNote: 7.3.2
20-
Suggests:
21-
testthat (>= 3.0.0)
2220
Config/testthat/edition: 3
2321
Imports:
24-
ggplot2
22+
ggplot2,
23+
knitr,
24+
quarto,
25+
testthat,
26+
usethis
27+
VignetteBuilder: quarto

‎AssumptionPlotter/README.Rmd‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
output: github_document
3+
---
4+
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
6+
7+
```{r, include = FALSE}
8+
knitr::opts_chunk$set(
9+
collapse = TRUE,
10+
comment = "#>",
11+
fig.path = "man/figures/README-",
12+
out.width = "100%"
13+
)
14+
```
15+
16+
# AssumptionPlotter
17+
18+
<!-- badges: start -->
19+
[![R-CMD-check](https://github.com/Programming-The-Next-Step-2026/Assumption-Plotter/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Programming-The-Next-Step-2026/Assumption-Plotter/actions/workflows/R-CMD-check.yaml)
20+
<!-- badges: end -->
21+
22+
The goal of AssumptionPlotter is to ...
23+
24+
## Installation
25+
26+
You can install the development version of AssumptionPlotter from [GitHub](https://github.com/) with:
27+
28+
``` r
29+
# install.packages("pak")
30+
pak::pak("Programming-The-Next-Step-2026/Assumption-Plotter")
31+
```
32+
33+
## Example
34+
35+
This is a basic example which shows you how to solve a common problem:
36+
37+
```{r example}
38+
library(AssumptionPlotter)
39+
## basic example code
40+
```
41+
42+
What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
43+
44+
```{r cars}
45+
summary(cars)
46+
```
47+
48+
You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
49+
50+
You can also embed plots, for example:
51+
52+
```{r pressure, echo = FALSE}
53+
plot(pressure)
54+
```
55+
56+
In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

‎AssumptionPlotter/vignettes/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.html
2+
*.R
3+
*_files

‎AssumptionPlotter/vignettes/AssumptionPlotter.qmd‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: "AssumptionPlotter"
3+
author: "Emma Akrong"
4+
date: "May 24, 2026"
5+
vignette: >
6+
%\VignetteIndexEntry{AssumptionPlotter}
7+
%\VignetteEngine{quarto::html}
8+
%\VignetteEncoding{UTF-8}
9+
knitr:
10+
opts_chunk:
11+
collapse: true
12+
comment: '#>'
13+
---
14+
15+
```{r}
16+
#| label: setup
17+
library(AssumptionPlotter)
18+
```
19+
20+
This package aims to give a an overview of whether the user's data matches the statistical model they intend to use.
21+
22+
While it tests whether the data matches meets the statistical assumptions of the models, it also aims to give an intuition of whether the statistical model will capture what the user wants see in the data.
23+
For example, in the case of a study with intensive longitudinal data, the user might expect to see change. This package aims to show how e.g., a VAR model would not be able to reflect this expectation.
24+
25+
26+
# Running AssumptionPlotter
27+
28+
The first step after installing the package is to run the function `run.plotter()`.
29+
30+
```{r, eval=F}
31+
run.plotter()
32+
```
33+
34+
35+
# TO ADD
36+
37+
::: {layout-ncol=3}
38+
39+
![1](figures/r1.png)
40+
41+
![2](figures/r2.png)
42+
43+
44+
![3](figures/r3.png)
45+
46+
![4](figures/r4.png)
47+
48+
![5](figures/r5.png)
49+
50+
![6](figures/r6.png)
51+
52+
53+
![7](figures/r7.png)
54+
55+
![8](figures/r8.png)
56+
57+
![9](figures/r9.png)
58+
59+
![10](figures/r10.png)
60+
61+
![11](figures/r11.png)
62+
63+
![12](figures/r12.png)
64+
65+
![13](figures/r13.png)
66+
67+
![14](figures/r14.png)
68+
69+
![15](figures/r15.png)
70+
71+
72+
![16](figures/r16.png)
73+
74+
![17](figures/r17.png)
75+
76+
77+
:::

0 commit comments

Comments
 (0)