bdverse: Development Guide
I The
bdverse
Packages
1
bdverse
1.1
Pkg Info:
1.2
Arcitecture
1.2.1
R functions dependency & information
1.2.2
Dependencies
1.2.3
Testing
2
bddwc
2.1
Pkg Info:
2.2
Pkg Architecture
2.2.1
Overview
2.2.2
R functions dependency & information
2.2.3
Dependencies
2.2.4
Testing
3
bddwc.app
4
bdchecks
5
bdchecks.app
6
bdclean
7
Pkgs Under Construction
7.1
bdvis
7.2
bddashboard
7.3
bdtools
II DevOps
8
Git & GitHub Strategy
8.1
Our needs
8.2
Our Git strategy
8.2.1
master
&
dev
8.2.2
Feature branches: pros & cons
8.2.3
Multi-packages release:
bdverse
is the key
8.3
Adjustments to working with GitHub
8.3.1
master
is the defult branch, why?
8.4
Versioning
9
Automated Tests
9.1
Unit testing
9.1.1
Create a test
9.1.2
Expect
9.1.3
Expect error
9.1.4
Expect invisible
9.1.5
Expect length
9.1.6
Expect match
9.1.7
Expect message
9.1.8
Expect named
9.1.9
Expect null
9.1.10
Expect output
9.1.11
expect setequal
9.1.12
Expect silent
9.1.13
Expect vector
9.1.14
Fail/ Success
9.1.15
Fail reporter
9.1.16
Check inheritance
9.1.17
Logical expectations
9.1.18
Skip a test
9.1.19
run all tests with custom location of tests
9.1.20
C++ unit testing
9.1.21
Regression test
9.1.22
Automatic testing
9.2
shinytest
9.2.1
Install shinytest
9.2.2
Record a test
9.2.3
Run the recorded test
9.3
Tests library
10
Continuous Integration (CI)
10.1
What is CI?
10.1.1
tic
10.2
bdverse
CI strategy
11
GitHub Actions
11.1
File Sync System
12
Defensive Programing
13
In-house Packages
13.1
Development: bddev/bdtests
13.2
Monitoring: bdmonitor
13.2.1
The bdmonitor dashboard
13.3
Experimentation: bddummy
14
Package submission
14.1
Peer-review: rOpenSci
14.2
CRAN
14.3
Papers
15
Getting Feedback
15.1
Report a bug or give feedback from the app
15.2
Submit a GitHub issue
bddwc
bdchecks
bdclean
15.3
Contribute
III Documentation
16
Centralized Documentation Scheme
16.1
The main idea
16.2
The implementation
16.2.1
Source Rmd files
16.2.2
Client Rmd files:
16.3
Centralized reposotoiers
16.3.1
bdtemplates
16.3.2
Graphics
17
User Guide
18
Website
19
Pkg README file
20
Dev Guide
21
Papers
22
Graphics
22.1
Package color
22.1.1
Retrieving pkg color
22.2
bdgraphics
IV Google Summer of Code
23
GSoC: what-why-how
24
Our GSoC projects
25
Future projects
Appendix
A
NEWS
A.1
0.0.1
B
References
(c) The bdverse team
bdverse: Development Guide
17
User Guide