update noRd and exports

NAMESPACE

@@ -1,18 +1,12 @@
 # Generated by roxygen2: do not edit by hand
 
 export(benders)
-export(clean_output_benders)
 export(delete_antares_output)
-export(enable_hurdle_costs)
-export(filter_output_areas)
-export(filter_output_links)
 export(get_whole_simulation_name)
 export(read_candidates)
 export(read_options)
 export(report)
 export(run_simulation)
-export(set_simulation_period)
-export(update_link)
 import(data.table)
 importFrom(antaresEditObject,getPlaylist)
 importFrom(antaresEditObject,setPlaylist)

R/benders_tools.R

@@ -16,6 +16,7 @@
 #' @importFrom assertthat assert_that
 #' @importFrom antaresRead simOptions getLinks getAreas
 #' @importFrom antaresEditObject updateGeneralSettings updateOptimizationSettings
+#' @noRd
 #' 
 set_antares_options <- function(benders_options, candidates, opts = antaresRead::simOptions())
 {

R/check.R

@@ -13,7 +13,7 @@
 #' 
 #' @importFrom  antaresRead simOptions readClusterDesc
 #' @importFrom dplyr filter
-#' 
+#' @noRd
 #' 
 benders_check <- function(candidates, opts = antaresRead::simOptions())
 {

R/clean.R

@@ -44,7 +44,7 @@ delete_antares_output <- function(simulation_name, opts = antaresRead::simOption
 #' 
 #' @importFrom antaresRead simOptions 
 #' @importFrom assertthat assert_that
-#' @export
+#' @noRd
 #' 
 clean_output_benders <- function(best_solution, unique_key, opts = antaresRead::simOptions())
 {

R/link.r

@@ -6,7 +6,7 @@
 #'   Name of one link
 #' @return 
 #' name of the first area that the link connects
-#' 
+#' @noRd
 #' 
 from <- function(link_name)
 {
@@ -21,7 +21,7 @@ from <- function(link_name)
 #'   Name of one link
 #' @return 
 #' name of the second area that the link connects
-#' 
+#' @noRd
 #' 
 to <- function(link_name)
 {
@@ -48,7 +48,7 @@ to <- function(link_name)
 #' 
 #' @importFrom assertthat assert_that
 #' @importFrom antaresRead simOptions
-#' @export
+#' @noRd
 #' 
 #' 
 
@@ -137,7 +137,7 @@ enable_hurdle_costs <- function(link_names, enable = TRUE, opts = antaresRead::s
 #' @importFrom assertthat assert_that
 #' @importFrom antaresRead simOptions
 #' @importFrom utils write.table
-#' @export
+#' @noRd
 #' 
 #' 
 update_link <- function(link_name, property_name, new_value, opts = antaresRead::simOptions())

R/master.R

@@ -20,6 +20,7 @@
 #' @importFrom antaresRead simOptions
 #' @importFrom assertthat assert_that
 #' @importFrom antaresEditObject getPlaylist
+#' @noRd
 #' 
 initiate_master <- function(candidates, exp_options , opts = antaresRead::simOptions())
 {
@@ -126,6 +127,7 @@ initiate_master <- function(candidates, exp_options , opts = antaresRead::simOpt
 #' 
 #' @importFrom antaresRead simOptions
 #' @importFrom assertthat assert_that
+#' @noRd
 #' 
 solve_master <- function(opts = antaresRead::simOptions(), relax_integrality = FALSE, ampl_path = NULL)
 {

R/read_candidates.R

@@ -196,7 +196,7 @@ read_candidates <- function(file, opts = antaresRead::simOptions())
 #'
 #' @return 
 #' Returns a vector of link name
-#' 
+#' @noRd
 #' 
 with_profile <- function(candidates)
 {
@@ -218,7 +218,7 @@ with_profile <- function(candidates)
 #'
 #' @return 
 #' Returns a vector of link name
-#' 
+#' @noRd
 #' 
 without_profile <- function(candidates)
 {

R/report.R

@@ -53,6 +53,7 @@ report <- function(benders_out = "last", file = default_report_file(opts), opts
 #' 
 #' @importFrom antaresRead simOptions
 #' @importFrom lubridate now
+#' @noRd
 #'                                       
 default_report_file <- function(opts = antaresRead::simOptions())
 {

R/simulation_settings.R

@@ -22,7 +22,7 @@
 #' 
 #' @importFrom assertthat assert_that
 #' @importFrom antaresRead simOptions
-#' @export
+#' @noRd
 #' 
 #' 
 filter_output_areas <- function(areas, filter, type, opts = antaresRead::simOptions())
@@ -91,7 +91,7 @@ filter_output_areas <- function(areas, filter, type, opts = antaresRead::simOpti
 #' 
 #' @importFrom assertthat assert_that
 #' @importFrom antaresRead simOptions
-#' @export
+#' @noRd
 #' 
 #' 
 filter_output_links <- function(links, filter, type, opts = antaresRead::simOptions())
@@ -158,7 +158,7 @@ filter_output_links <- function(links, filter, type, opts = antaresRead::simOpti
 #' @importFrom antaresRead simOptions
 #' @importFrom data.table first last
 #' @importFrom antaresEditObject updateGeneralSettings
-#' @export
+#' @noRd
 #' 
 set_simulation_period <- function(weeks, opts = antaresRead::simOptions())
 {