lint r code

.Rbuildignore

@@ -36,3 +36,4 @@ pkgdown
 .dockerignore
 Dockerfile
 docker-compose.yml
+.lintr

.lintr

@@ -0,0 +1,9 @@
+linters: with_defaults(
+  object_name_linter = NULL,
+  camel_case_linter = NULL,
+  closed_curly_linter = NULL,
+  cyclocomp_linter = NULL,
+  open_curly_linter = NULL,
+  todo_comment_linter = NULL,
+  undesirable_operator_linter = NULL
+)

DESCRIPTION

@@ -1,8 +1,14 @@
 Package: wheretowork
-Title: Systematic conservation planning application
+Title: Interactive systematic conservation planning application
 Version: 0.0.0.9000
 Description:
-  Interactive application for systematic conservation planning
+    Launch an interactive web application for systematic conservation planning.
+    Data can be accessed using projects available on disk, uploaded using
+    project files, or uploaded in shapefile format. Prioritizations are
+    generated using mixed integer programming techniques. The performance of
+    candidate prioritizations can be examined using summary statistics,
+    interactive charts, and tables. Finally, data and prioritizations can also
+    be downloaded for subsequent analysis.
 Authors@R: c(
   person(c('Jeffrey', 'O'), 'Hanson',
     email='[email protected]', role = c('aut', 'cre'),
@@ -107,8 +113,8 @@ Collate:
     'class_Statistic.R'
     'class_WeightResults.R'
     'fct_find_projects.R'
-    'fct_generate_min_set_solution.R'
-    'fct_generate_min_shortfall_solution.R'
+    'fct_min_set_solution.R'
+    'fct_min_shortfall_solution.R'
     'fct_read_project.R'
     'fct_simulate_includes.R'
     'fct_simulate_legends.R'

NAMESPACE

@@ -29,8 +29,6 @@ export(error_message)
 export(exportSidebarPane)
 export(extract_data_matrix)
 export(find_projects)
-export(generate_min_set_solution)
-export(generate_min_shortfall_solution)
 export(get_golem_config)
 export(horizontalPickerInput)
 export(importModal)
@@ -45,6 +43,8 @@ export(leaflet_map)
 export(mapManager)
 export(mapManagerOutput)
 export(mapManagerSidebarPane)
+export(min_set_solution)
+export(min_shortfall_solution)
 export(newSolutionSidebarPane)
 export(new_categorical_legend)
 export(new_continuous_legend)

R/app_config.R

@@ -2,7 +2,8 @@
 #'
 #' NOTE: If you manually change your package name in the DESCRIPTION,
 #' don't forget to change it here too, and in the config file.
-#' For a safer name change mechanism, use the `golem::set_golem_name()` function.
+#' For a safer name change mechanism, use the `golem::set_golem_name()`
+#' function.
 #'
 #' @param ... character vectors, specifying subdirectory and file(s)
 #' within your package. The default, none, returns the root of the app.
@@ -20,17 +21,15 @@ app_sys <- function(...) {
 #' @param use_parent Logical, scan the parent directory for config file.
 #'
 #' @export
-get_golem_config <- function(
-  value,
-  config = Sys.getenv(
-    "GOLEM_CONFIG_ACTIVE",
-    Sys.getenv(
-      "R_CONFIG_ACTIVE",
-      "default"
-    )
-  ),
-  use_parent = TRUE
-){
+get_golem_config <- function(value,
+                             config = Sys.getenv(
+                               "GOLEM_CONFIG_ACTIVE",
+                               Sys.getenv(
+                                 "R_CONFIG_ACTIVE",
+                                 "default"
+                               )
+                             ),
+                             use_parent = TRUE) {
   config::get(
     value = value,
     config = config,

R/app_server.R

@@ -3,7 +3,7 @@
 #' @param input,output,session Internal parameters for {shiny}.
 #'     DO NOT REMOVE.
 #' @noRd
-app_server <- function(input, output, session ) {
+app_server <- function(input, output, session) {
 
   # initialization
   ## initialize app

R/app_ui.R

@@ -11,8 +11,8 @@ app_ui <- function(request) {
     # app content
     shiny::fillPage(
 
-    ## manually insert shinyBS JS code
-    htmltools::tags$script(src = "www/shinyBS-copy.js"),
+      ## manually insert shinyBS JS code
+      htmltools::tags$script(src = "www/shinyBS-copy.js"),
 
       ## start up screen
       shinybusy::busy_start_up(
@@ -51,7 +51,6 @@ app_ui <- function(request) {
         newSolutionSidebarPane(id = "newSolutionPane"),
         solutionResultsSidebarPane(id = "solutionResultsPane")
       )
-
     )
   )
 }
@@ -63,7 +62,7 @@ app_ui <- function(request) {
 #'
 #' @importFrom golem add_resource_path activate_js favicon bundle_resources
 #' @noRd
-golem_add_external_resources <- function(){
+golem_add_external_resources <- function() {
   # add resources
   golem::add_resource_path(
     "www", app_sys("app/www")

R/class_CategoricalLegend.R

@@ -26,7 +26,8 @@ CategoricalLegend <- R6::R6Class(
         is.character(colors),
         assertthat::noNA(colors),
         all(nchar(colors) %in% c(7, 9)),
-        all(substr(colors, 1, 1) == "#"))
+        all(substr(colors, 1, 1) == "#")
+      )
       self$values <- values
       self$colors <- colors
     },
@@ -91,7 +92,6 @@ CategoricalLegend <- R6::R6Class(
 #'
 #' # print object
 #' print(l)
-#'
 #' @export
 new_categorical_legend <- function(values, colors) {
   CategoricalLegend$new(values = values, colors)

R/class_ContinuousLegend.R

@@ -39,7 +39,8 @@ ContinuousLegend <- R6::R6Class(
         is.character(colors),
         assertthat::noNA(min_value),
         all(nchar(colors) %in% c(7, 9)),
-        all(substr(colors, 1, 1) == "#"))
+        all(substr(colors, 1, 1) == "#")
+      )
       self$min_value <- min_value
       self$max_value <- max_value
       self$colors <- colors
@@ -93,7 +94,6 @@ ContinuousLegend <- R6::R6Class(
         colors = self$colors
       )
     }
-
   )
 )
 
@@ -120,9 +120,9 @@ ContinuousLegend <- R6::R6Class(
 #'
 #' # print object
 #' print(l)
-#'
 #' @export
 new_continuous_legend <- function(min_value, max_value, colors, n = 4) {
   ContinuousLegend$new(
-    min_value = min_value, max_value = max_value, colors = colors, n = n)
+    min_value = min_value, max_value = max_value, colors = colors, n = n
+  )
 }