Skip to content

Commit

Permalink
update developer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
hsiaoyi0504 committed Apr 14, 2024
1 parent 99fdf9a commit 5a0b9e3
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,20 @@ plot_correlation_heatmap(ccrcc, indicate="condition", exp="TMT")


## Developer guide
- `devtools::build()` and `devtools::test()`
- `devtools::document()` when you add a function
- `usethis::use_import_from("package name", "function name")` to include dependencies
- Use `lintr` and `styler` to improve code quality
- Start project `renv::init()`:
You may see message similar to this
```
lintr::lint_package()
styler::style_pkg()
* Using Bioconductor version '3.18'.
This project already has a lockfile. What would you like to do?
1: Restore the project from the lockfile.
2: Discard the lockfile and re-initialize the project.
3: Activate the project without snapshotting or installing any packages.
4: Abort project initialization.
```
We recommend to choose 2 here to initialize the project since some dependencies depend on the R version and bioconductor version use
- You may use `lintr::lint_package()` and `styler::style_pkg()` to make sure coding styles consistent
- `devtools::build()` and `devtools::test()` to build and test the package, respectively
- `devtools::document()` when you add a function
- `usethis::use_import_from("package name", "function name")` to include dependencies

0 comments on commit 5a0b9e3

Please sign in to comment.