Development

Installation

Requirements

• R
• RStudio
• Git

Setup

1. Fork the cytominer repository
2. Clone the project:

   git clone [email protected]:USERNAME/cytominer.git
   

3. In RStudio, create a new project in this directory
4. Install devtools:

   install.packages("devtools")
   

5. Install dependencies:

   devtools::install_dev_deps(".")
   

Style

1. Style the package:

   install.packages("styler")
   styler::style_pkg()
   

2. Verify the changes.

Lint

1. Lint the package:

   install.packages("lintr")
   lintr::lint_package()
   

2. Address warnings
3. Iterate until no warnings

Test

1. Test the package (or using the RStudio shortcut for your OS):

   devtools::test()
   

2. To test a specific file (e.g. test-aggregate.R):

   devtools::test(filter = "aggregate")
   

Document

1. Build the documentation (or using the RStudio shortcut for your OS):

   devtools::document()
   

2. (Optional) Build the pkgdown website:

   pkgdown::build_site()
   

Build

1. Build the package (or using the RStudio shortcut for your OS):

   devtools::build()
   

2. To test a specific file (e.g. test-aggregate.R):

   devtools::test(filter = "aggregate")
   

Check

1. Check the package (or using the RStudio shortcut for your OS):

   devtools::check()