dbmatrix-r/_pkgdown.yml at dev · dbverse-org/dbmatrix-r · 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
url: https://dbverse-org.github.io/dbmatrix-r/
template:
  bootstrap: 5
  light-switch: true

navbar:
  structure:
    left:  [intro, reference, articles, tutorials, news]
    right: [search, github, lightswitch]

  components:
    github:
      icon: fab fa-github
      href: https://github.com/dbverse-org/dbmatrix-r
      aria-label: GitHub

reference:
  - title: "S4 Classes"
    desc: "S4 class definitions for dbMatrix objects"
    contents:
      - dbMatrix-class
      - dbDenseMatrix-class
      - dbSparseMatrix-class

  - title: "Coercion"
    desc: "Methods for coercing `dbMatrix` objects to other types"
    contents:
      - coerce-dbMatrix-dgCMatrix
      - coerce-dbMatrix-matrix
      - coerce-matrix-dbMatrix

  - title: "Constructor"
    desc: "Function for creating `dbMatrix` objects"
    contents:
      - has_concept("dbMatrix")

  - title: "Matrix Summary Operations"
    desc: "Methods to compute summary statistics for `dbMatrix` objects"
    contents:
      - has_concept("summary")

  - title: "Matrix Transformations"
    desc: "Methods for transforming `dbMatrix` objects"
    contents:
      - has_concept("transform")
      - compute.dbMatrix
      - db_svd

  - title: "Matrix Properties"
    desc: "Methods to retrieve basic properties of `dbMatrix` objects"
    contents:
      - has_concept("matrix_props")

  - title: "dbData objects"
    desc: "Convenience methods for `dbData` objects"
    contents:
      - has_concept("dbData")
      - 'dbLoad,DBIConnection-method'

  - title: "Package Options"
    desc: "Global options for the dbMatrix package"
    contents:
      - dbMatrix_options