-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathpkgdown_notes.Rmd
33 lines (22 loc) · 1.12 KB
/
pkgdown_notes.Rmd
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
* I installed pkgdown on my laptop locally under the "seurat" conda env
`conda activate seurat`
* This command builds the site and previews it
`pkgdown::build_site()`
* This is the .yml configuration file for the actual pkgdown site:
https://github.com/r-lib/pkgdown/blob/main/pkgdown/_pkgdown.yml
- idk how some things work, like I can't change author name??
* The home page is just from the README.md. Not sure how to add more pages yet.
Need to make function documentation before building the package!!!
This is done with the following command from the main directory in the pacakge scWGCNA/:
Found this here: https://tinyheero.github.io/jekyll/update/2015/07/26/making-your-first-R-package.html
```
# document the functions
devtools::document()
# build the site:
pkgdown::build_site()
```
To group functions together in the reference page, you need to maually add them
in the .yml config file. Currently I have only put a few functions in each group
so there's more I need to add. This is also nice since we can just easily ignore
random helper functions.
I have no idea how to deploy yet. I also have no idea how to customize it.