Skip to content

Commit d836665

Browse files
committed
push for preview
1 parent a58c767 commit d836665

14 files changed

+104
-23
lines changed

.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
^pkgdown$
1414
^vignettes/articles$
1515
^.*\.Rproj$
16+
^data-raw$

DESCRIPTION

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Package: delphidocs
2-
Title: pkgdown template for CMU Delphi
2+
Title: pkgdown template for Delphi
33
Version: 0.0.1
44
Authors@R: c(
55
person("Daniel J.", "McDonald", , "[email protected]", role = c("aut", "cre")),
6-
person("CMU's Delphi Research Group", role = c("cph", "fnd"))
6+
person("Delphi Research Group", role = c("cph", "fnd"))
77
)
8-
Description: A pkgdown template for the CMU Delphi R packages.
8+
Description: A pkgdown template for the Delphi R packages.
99
License: MIT + file LICENSE
1010
URL: https://github.com/cmu-delphi/delphidocs
1111
BugReports: https://github.com/cmu-delphi/delphidocs/issues
@@ -14,13 +14,16 @@ Depends:
1414
Imports:
1515
cli,
1616
glue
17-
Config/Needs/website: rmarkdown
17+
Suggests:
18+
knitr,
19+
rmarkdown
20+
VignetteBuilder:
21+
knitr
22+
Config/Needs/website:
23+
rmarkdown
24+
cmu-delphi/delphidocs
1825
Config/testthat/edition: 3
1926
Encoding: UTF-8
2027
LazyData: true
2128
Roxygen: list(markdown = TRUE)
2229
RoxygenNote: 7.3.2
23-
Suggests:
24-
knitr,
25-
rmarkdown
26-
VignetteBuilder: knitr

NAMESPACE

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# Generated by roxygen2: do not edit by hand
22

33
export(consult_oracle)
4+
importFrom(cli,cat_line)
5+
importFrom(cli,cli_h2)
6+
importFrom(cli,cli_inform)
7+
importFrom(cli,col_yellow)

R/consult_oracle.R

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
#' consult_oracle("A")
1313
consult_oracle <- function(query) {
1414
if (missing(query)) {
15-
cli::cli_inform("Did you have a question?")
15+
cli_inform("Did you have a question?")
1616
}
1717
resp <- sample(delphidocs::responses, 1)
18-
cli::cli_h2(cli::col_yellow("The oracle says: "))
19-
cli::cli_inform(glue::glue(cli::symbol$fancy_question_mark, " {resp}."))
20-
cli::cat_line("")
18+
cli_h2(col_yellow("The oracle says: "))
19+
cli_inform(glue::glue(cli::symbol$fancy_question_mark, " {resp}."))
20+
cat_line("")
2121
invisible(resp)
2222
}

R/delphidocs-package.R

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#' Some things the oracle might say
2+
"responses"
3+
4+
#' Some useful colours
5+
"colours"
6+
7+
#' @importFrom cli cli_inform cli_h2 cat_line col_yellow
8+
"_PACKAGE"

R/responses.R

-2
This file was deleted.

README.Rmd

+7-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ knitr::opts_chunk$set(
2121
[![CRAN status](https://www.r-pkg.org/badges/version/delphidocs)](https://CRAN.R-project.org/package=delphidocs)
2222
<!-- badges: end -->
2323

24-
`{delphidocs}` provides a custom pkgdown template for CMU Delphi packages.
24+
`{delphidocs}` provides a custom pkgdown template for Delphi packages.
2525
Please don’t use it for your own package, but feel free to modify it for
2626
your own purposes.
2727

@@ -37,14 +37,18 @@ You probably shouldn't install this package. It's just a template.
3737
To use the `{delphidocs}` template for your pkgdown site,
3838
add the following to your `_pkgdown.yml` file:
3939

40-
```{yaml example}
40+
``` yaml
41+
---
4142
template:
4243
package: delphidocs
44+
---
4345
```
4446

4547
You will also need to add the following to your `DESCRIPTION` file:
4648

47-
```{yaml needs}
49+
``` yaml
50+
---
4851
Config/Needs/website: cmu-delphi/delphidocs
52+
---
4953
```
5054

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
1111
status](https://www.r-pkg.org/badges/version/delphidocs)](https://CRAN.R-project.org/package=delphidocs)
1212
<!-- badges: end -->
1313

14-
`{delphidocs}` provides a custom pkgdown template for CMU Delphi
15-
packages. Please don’t use it for your own package, but feel free to
16-
modify it for your own purposes.
14+
`{delphidocs}` provides a custom pkgdown template for Delphi packages.
15+
Please don’t use it for your own package, but feel free to modify it for
16+
your own purposes.
1717

1818
Inspired by [rotemplate](https://github.com/ropensci-org/rotemplate).
1919

@@ -27,12 +27,16 @@ To use the `{delphidocs}` template for your pkgdown site, add the
2727
following to your `_pkgdown.yml` file:
2828

2929
``` yaml
30+
---
3031
template:
3132
package: delphidocs
33+
---
3234
```
3335

3436
You will also need to add the following to your `DESCRIPTION` file:
3537

3638
``` yaml
39+
---
3740
Config/Needs/website: cmu-delphi/delphidocs
41+
---
3842
```

data-raw/colours.R

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
colours <- c(
2+
fg = "#172431",
3+
bg = "#fff",
4+
cmu_red = "#C41230",
5+
skibo_red = "#941120",
6+
highlands_blue = "#007BC0",
7+
berkley_blue = "#002676",
8+
berkeley_gold = "#FDB515",
9+
ubc_blue = "#002145",
10+
ubc_secondary = "#00A7E1",
11+
fifty = "#8C338F",
12+
complem = "#368f33"
13+
)
14+
15+
usethis::use_data(colours, overwrite = TRUE)

data/colours.rda

260 Bytes
Binary file not shown.

inst/pkgdown/_pkgdown.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ template:
55
fg: "#172431"
66
base_font: {google: "Open Sans"}
77
heading_font: {google: "Source Serif Pro"}
8-
primary: "#007BC0"
8+
primary: "#941120"
9+
secondary: "#8C338F"
910
border-radius: 0
10-
headings-color: "#941120"
11+
headings-color: "#002676"
1112
navbar-light-color: "$headings-color"
1213
navbar-light-brand-color: "$headings-color"
1314
navbar-light-hover-color: "$headings-color"

man/colours.Rd

+16
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/delphidocs-package.Rd

+27
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/responses.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)