Skip to content

Commit

Permalink
fix .Rd
Browse files Browse the repository at this point in the history
  • Loading branch information
the-mayer committed Oct 30, 2024
1 parent f4b50f4 commit dd86b3c
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 5 deletions.
18 changes: 18 additions & 0 deletions R/assign_job_queue.R
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ mapOption2Process <- function() {

}

#' mapAdvOption2Process
#'
#' @description
#' Use MolEvolvR advanced options to get associated processes
#'
#' @param advanced_opts character vector of MolEvolvR advanced options
Expand Down Expand Up @@ -79,6 +82,9 @@ mapAdvOption2Process <- function(advanced_opts) {

}

#' calculateProcessRuntime
#'
#' @description
#' Scrape MolEvolvR logs and calculate median processes
#'
#' @param dir_job_results [chr] path to MolEvolvR job_results
Expand Down Expand Up @@ -227,6 +233,9 @@ writeProcessRuntime2TSV <- function(dir_job_results, filepath) {

}

#' writeProcessRuntime2YML
#'
#' @description
#' Compute median process runtimes, then write a YAML list of the processes and
#' their median runtimes in seconds to the path specified by 'filepath'.
#'
Expand Down Expand Up @@ -304,6 +313,9 @@ writeProcessRuntime2YML <- function(dir_job_results, filepath = NULL) {
})
}

#' getProcessRuntimeWeights
#'
#' @description
#' Quickly get the runtime weights for MolEvolvR backend processes
#'
#' @param dir_job_results [chr] path to MolEvolvR job_results
Expand Down Expand Up @@ -494,6 +506,9 @@ calculateEstimatedWallTimeFromOpts <- function(advanced_opts,
}


#' assignJobQueue
#'
#' @description
#' Decision function to assign job queue
#'
#' @param t_sec_estimate estimated number of seconds a job will process
Expand Down Expand Up @@ -555,6 +570,9 @@ assignJobQueue <- function(

}

#' plotEstimatedWallTimes
#'
#' @description
#' Plot the estimated runtimes for different advanced options and number
#' of inputs
#'
Expand Down
3 changes: 1 addition & 2 deletions man/acc2Lineage.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions man/efetchIPG.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/sinkReset.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit dd86b3c

Please sign in to comment.