Skip to content

Commit

Permalink
beef up website
Browse files Browse the repository at this point in the history
  • Loading branch information
maxheld83 committed Sep 12, 2024
1 parent a0d873b commit 206872e
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 9 deletions.
9 changes: 5 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: elf
Title: Assorted R helpers
Version: 0.0.0.9000
Authors@R:
Authors@R:
c(
person(
given = "Maximilian",
Expand All @@ -15,9 +15,9 @@ Authors@R:
role = c("cph", "fnd")
)
)
Description:
Description:
Assorted R helpers.
URL: https://github.com/dataheld/elf
URL: https://github.com/dataheld/elf, https://elf.maxheld.de
BugReports: https://github.com/dataheld/elf/issues
License: file LICENSE
Encoding: UTF-8
Expand All @@ -32,10 +32,11 @@ Imports:
rlang,
usethis,
withr
Suggests:
Suggests:
rstudioapi,
shinytest2,
testthat (>= 3.0.0)
Config/testthat/edition: 3
Config/testthat/parallel: true
Config/Needs/website: rmarkdown
RoxygenNote: 7.3.2
2 changes: 1 addition & 1 deletion R/dependencies.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#' @inheritDotParams rlang::check_installed
#' @example inst/examples/dependencies/is_installed2/missing.R
#' @example inst/examples/dependencies/is_installed2/present.R
#' @keywords dependencies helper
#' @family dependencies helper
#' @export
is_installed2 <- function(...) {
if (rlang::is_installed(...)) {
Expand Down
5 changes: 3 additions & 2 deletions R/examples.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
#' manual collation instructions via `#' @include foo.R` may be neeeded,
#' but that will quickly make the package unwieldy.
#' @inheritParams fs::path_package
#' @keywords path helpers, example helpers
#' @family path helpers
#' @family example helpers
#' @export
source_pef <- function(package, ...) {
path <- fs::path_package(package = package, "examples", ..., ext = "R")
Expand All @@ -34,7 +35,7 @@ source_pef_elf <- purrr::partial(source_pef, package = "elf")
#' @inheritParams fs::path
#' @inheritParams usethis::use_template
#' @export
#' @keywords example helpers
#' @family example helpers
use_ex_file <- function(..., open = rlang::is_interactive()) {
# TODO https://github.com/dataheld/elf/issues/2
# take currently open file name from usethis
Expand Down
2 changes: 1 addition & 1 deletion R/options.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' @param x An option name.
#' @inheritParams options::opt_set
#' @inheritParams withr::defer
#' @keywords options helper
#' @family options helpers
#' @export
opt_set_local2 <- function(x,
value,
Expand Down
2 changes: 1 addition & 1 deletion R/tests.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' To be used as an argument for [testthat::expect_snapshot()].
#' @param x A character vector.
#' @keywords snapshot helpers
#' @family test helpers
#' @name transform_snap
NULL

Expand Down
14 changes: 14 additions & 0 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
---
url: https://elf.maxheld.de
authors:
Maximilian Held:
href: http://www.maxheld.de
template:
bootstrap: 5
bootswatch: cosmo
reference:
- title: Dependencies
- contents:
- has_concept("dependencies helper")
- title: Examples
- contents:
- has_concept("example helpers")
- title: Options
- contents:
- has_concept("options helpers")
- title: Tests
- contents:
- has_concept("test helpers")

0 comments on commit 206872e

Please sign in to comment.