2024-10-10 11:39:56 +00:00
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --> < html lang = "en" > < head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" > < meta charset = "utf-8" > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" > < meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" > < title > Solve grouping based on priorities or costs. — prioritized_grouping • prioritized.grouping< / title > < script src = "../deps/jquery-3.6.0/jquery-3.6.0.min.js" > < / script > < meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" > < link href = "../deps/bootstrap-5.3.1/bootstrap.min.css" rel = "stylesheet" > < script src = "../deps/bootstrap-5.3.1/bootstrap.bundle.min.js" > < / script > < link href = "../deps/font-awesome-6.4.2/css/all.min.css" rel = "stylesheet" > < link href = "../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel = "stylesheet" > < script src = "../deps/headroom-0.11.0/headroom.min.js" > < / script > < script src = "../deps/headroom-0.11.0/jQuery.headroom.min.js" > < / script > < script src = "../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js" > < / script > < script src = "../deps/clipboard.js-2.0.11/clipboard.min.js" > < / script > < script src = "../deps/search-1.0.0/autocomplete.jquery.min.js" > < / script > < script src = "../deps/search-1.0.0/fuse.min.js" > < / script > < script src = "../deps/search-1.0.0/mark.min.js" > < / script > <!-- pkgdown --> < script src = "../pkgdown.js" > < / script > < meta property = "og:title" content = "Solve grouping based on priorities or costs. — prioritized_grouping" > < meta name = "description" content = "Solve grouping based on priorities or costs." > < meta property = "og:description" content = "Solve grouping based on priorities or costs." > < / head > < body >
< a href = "#main" class = "visually-hidden-focusable" > Skip to contents< / a >
< nav class = "navbar navbar-expand-lg fixed-top bg-light" data-bs-theme = "light" aria-label = "Site navigation" > < div class = "container" >
< a class = "navbar-brand me-2" href = "../index.html" > prioritized.grouping< / a >
< small class = "nav-text text-muted me-auto" data-bs-toggle = "tooltip" data-bs-placement = "bottom" title = "" > 24.10.1< / small >
< button class = "navbar-toggler" type = "button" data-bs-toggle = "collapse" data-bs-target = "#navbar" aria-controls = "navbar" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" > < / span >
< / button >
< div id = "navbar" class = "collapse navbar-collapse ms-3" >
< ul class = "navbar-nav me-auto" > < li class = "active nav-item" > < a class = "nav-link" href = "../reference/index.html" > Reference< / a > < / li >
< li class = "nav-item" > < a class = "nav-link" href = "../news/index.html" > Changelog< / a > < / li >
< / ul > < ul class = "navbar-nav" > < li class = "nav-item" > < form class = "form-inline" role = "search" >
< input class = "form-control" type = "search" name = "search-input" id = "search-input" autocomplete = "off" aria-label = "Search site" placeholder = "Search for" data-search-index = "../search.json" > < / form > < / li >
< / ul > < / div >
< / div >
< / nav > < div class = "container template-reference-topic" >
< div class = "row" >
< main id = "main" class = "col-md-9" > < div class = "page-header" >
< h1 > Solve grouping based on priorities or costs.< / h1 >
< div class = "d-none name" > < code > prioritized_grouping.Rd< / code > < / div >
< / div >
< div class = "ref-description section level2" >
< p > Solve grouping based on priorities or costs.< / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-usage" > Usage< a class = "anchor" aria-label = "anchor" href = "#ref-usage" > < / a > < / h2 >
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span > < span class = "fu" > prioritized_grouping< / span > < span class = "op" > (< / span > < / span >
< span > < span class = "va" > data< / span > ,< / span >
< span > cap_classes < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > excess_space < span class = "op" > =< / span > < span class = "fl" > 20< / span > ,< / span >
< span > pre_grouped < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > seed < span class = "op" > =< / span > < span class = "fl" > 6293812< / span > < / span >
< span > < span class = "op" > )< / span > < / span > < / code > < / pre > < / div >
< / div >
< div class = "section level2" >
< h2 id = "arguments" > Arguments< a class = "anchor" aria-label = "anchor" href = "#arguments" > < / a > < / h2 >
< dl > < dt id = "arg-data" > data< a class = "anchor" aria-label = "anchor" href = "#arg-data" > < / a > < / dt >
2024-11-14 13:33:38 +00:00
< dd > < p > data set in wide format. First column should be ID, then one column
2024-10-10 11:39:56 +00:00
for each group containing cost/priorities.< / p > < / dd >
< dt id = "arg-cap-classes" > cap_classes< a class = "anchor" aria-label = "anchor" href = "#arg-cap-classes" > < / a > < / dt >
< dd > < p > class capacity. Numeric vector length 1 or length=number
of groups. If NULL equal group sizes are calculated. Default is NULL.< / p > < / dd >
< dt id = "arg-excess-space" > excess_space< a class = "anchor" aria-label = "anchor" href = "#arg-excess-space" > < / a > < / dt >
< dd > < p > allowed excess group fill in percentage. Default is 20.
Supplied group capacities will be enlarged by this factors and rounded up.< / p > < / dd >
< dt id = "arg-pre-grouped" > pre_grouped< a class = "anchor" aria-label = "anchor" href = "#arg-pre-grouped" > < / a > < / dt >
< dd > < p > Pre grouped data set. Optional. Should contain two
columns, 'id' and 'group', with 'group' containing the given group index.< / p > < / dd >
< dt id = "arg-seed" > seed< a class = "anchor" aria-label = "anchor" href = "#arg-seed" > < / a > < / dt >
< dd > < p > specify a seed value. For complex problems.< / p > < / dd >
< / dl > < / div >
< div class = "section level2" >
< h2 id = "value" > Value< a class = "anchor" aria-label = "anchor" href = "#value" > < / a > < / h2 >
< p > list of custom class 'prioritized_groups_list'< / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-examples" > Examples< a class = "anchor" aria-label = "anchor" href = "#ref-examples" > < / a > < / h2 >
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span class = "r-in" > < span > < span class = "co" > # prioritized_grouping(< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "co" > # data=read.csv(here::here("data/prioritized_sample.csv")),< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "co" > # pre_grouped=read.csv(here::here("data/pre_grouped.csv"))) |> plot()< / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "https://rdrr.io/r/base/data.frame.html" class = "external-link" > data.frame< / a > < / span > < span class = "op" > (< / span > id< span class = "op" > =< / span > < span class = "fu" > < a href = "https://rdrr.io/r/base/paste.html" class = "external-link" > paste0< / a > < / span > < span class = "op" > (< / span > < span class = "st" > "id"< / span > ,< span class = "fl" > 1< / span > < span class = "op" > :< / span > < span class = "fl" > 100< / span > < span class = "op" > )< / span > ,< / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > < a href = "https://rdrr.io/r/base/matrix.html" class = "external-link" > matrix< / a > < / span > < span class = "op" > (< / span > < span class = "fu" > < a href = "https://rdrr.io/r/base/lapply.html" class = "external-link" > replicate< / a > < / span > < span class = "op" > (< / span > < span class = "fl" > 100< / span > ,< span class = "fu" > < a href = "https://rdrr.io/r/base/sample.html" class = "external-link" > sample< / a > < / span > < span class = "op" > (< / span > < span class = "fu" > < a href = "https://rdrr.io/r/base/c.html" class = "external-link" > c< / a > < / span > < span class = "op" > (< / span > < span class = "fl" > 1< / span > < span class = "op" > :< / span > < span class = "fl" > 5< / span > ,< span class = "fu" > < a href = "https://rdrr.io/r/base/rep.html" class = "external-link" > rep< / a > < / span > < span class = "op" > (< / span > < span class = "cn" > NA< / span > ,< span class = "fl" > 15< / span > < span class = "op" > )< / span > < span class = "op" > )< / span > ,< span class = "fl" > 10< / span > < span class = "op" > )< / span > < span class = "op" > )< / span > ,ncol< span class = "op" > =< / span > < span class = "fl" > 10< / span > ,byrow < span class = "op" > =< / span > < span class = "cn" > TRUE< / span > < span class = "op" > )< / span > < span class = "op" > )< / span > < span class = "op" > |> < / span > < / span > < / span >
< span class = "r-in" > < span > < span class = "fu" > prioritized_grouping< / span > < span class = "op" > (< / span > < span class = "op" > )< / span > < / span > < / span >
< / code > < / pre > < / div >
< / div >
< / main > < aside class = "col-md-3" > < nav id = "toc" aria-label = "Table of contents" > < h2 > On this page< / h2 >
< / nav > < / aside > < / div >
< footer > < div class = "pkgdown-footer-left" >
< p > Developed by Andreas Gammelgaard Damsbo.< / p >
< / div >
< div class = "pkgdown-footer-right" >
< p > Site built with < a href = "https://pkgdown.r-lib.org/" class = "external-link" > pkgdown< / a > 2.1.1.< / p >
< / div >
< / footer > < / div >
< / body > < / html >
