jdtools/_pkgdown.yml at master · jdtrat/jdtools · GitHub

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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
destination: docs

url: https://jdtools.jdtrat.com
repo:
    home: https://github.com/jdtrat/jdtools/
    source: https://github.com/jdtrat/jdtools/blob/master/
    issue: https://github.com/jdtrat/jdtools/issues/
    user: https://github.com/jdtrat/

template:
  package: jdtdown
  opengraph:
    image:
      src: man/figures/logo.png
      alt: "jdtools package"
    twitter:
      creator: "@jdtrat"
      card: summary

authors:
  Jonathan Trattner:
    href: "https://jdtrat.com"

development:
  mode: auto

home:
  strip_header: true
  links:
  - text: Learn more
    href: ""

# structure of website themed with jdtdown
# based on structure of jdtdown
navbar:
  title: ~
  type: default
  structure:
    left:  [intro, examples, articles]
    right: [reference, news, github]
  components:
    home:
    articles:
      text: Articles
      menu:
        - text: "No Article"
    reference:
      text: Reference
      href: reference/index.html
    github:
      icon: fab fa-github fa-lg
      href: https://github.com/jdtrat/jdtools
    news:
      text: News
      menu:
        - text: "Changelog"
          href: news/index.html
        - text: "------------------"
        - text: "Blog posts"
        # Add blog post where a released version is mentioned.
        - text: "No blog post"
        # - text: Version 0.2
        #   href: <url>

reference:
- title: "Command Line Tools"
  desc: >
    Functions for interacting with users via the command line.
  contents:
    - cl_yes_no_action
    - cl_text_action
    - cl_yes_no_lgl
    - cl_text_input
- title: "Saving and Loading Objects"
  desc: >
    Functions for more easily saving and loading R (.RDS) objects with RStudio.
  contents:
    - save_object
    - load_object
    - set_object_path
    - get_object_path
    - unset_object_path
- title: "File Functions"
  decc: >
    Functions for manipulating files with R in RStudio.
  contents:
    - file_open
    - file_new
    - file_copy
    - file_delete
- title: "Working with Options"
  decc: >
    Functions for working with (package-specific) options.
  contents:
    - opt_set
    - opt_get
    - opt_ls
    - opt_rm
    - opt_rm_all
- title: "Strings and Identifiers"
  desc: >
    Functions for working with strings and creating unique identifiers.
  contents:
    - extract_before
    - extract_after
    - extract_between
    - time_string
    - rand_str
- title: "Vector Manipulations"
  decc: >
    Functions for working with vectors.
  contents:
    - vec_between
- title: "Miscellaneous"
  desc: >
    Functions that don't fall as easily into categories but are useful utilities for a variety of tasks.
  contents:
    - cls_abort
    - cls_check
    - how_many
    - get_sub_name