Argumentos padrão

Introdução à Escrita de Funções em R

Richie Cotton

Data Evangelist at DataCamp

Problemas com toss_coin()

toss_coin <- function(n_flips, p_head) {
  coin_sides <- c("head", "tail")
  weights <- c(p_head, 1 - p_head)
  sample(coin_sides, n_flips, replace = TRUE, prob = weights)
}

Defina o padrão na assinatura

toss_coin <- function(n_flips, p_head = 0.5) {
  coin_sides <- c("head", "tail")
  weights <- c(p_head, 1 - p_head)
  sample(coin_sides, n_flips, replace = TRUE, prob = weights)
}

Um modelo com padrões

my_fun <- function(data_arg1, data_arg2, detail_arg1 = default1) {
  # Do something
}

Outros tipos de padrão

args(median)

function (x, na.rm = FALSE, ...)

library(jsonlite)
args(fromJSON)

function (txt, simplifyVector = TRUE, simplifyDataFrame = simplifyVector, 
    simplifyMatrix = simplifyVector, flatten = FALSE, ...)

Padrões NULL

Por convenção, isso significa

A função fará um tratamento especial deste argumento. Leia a documentação.

args(set.seed)

function (seed, kind = NULL, normal.kind = NULL)

Padrões categóricos

Passe um vetor de caracteres na assinatura.
Chame match.arg() no corpo.

args(prop.test)

function (x, n, p = NULL, alternative = c("two.sided", "less", "greater"), 
  conf.level = 0.95, correct = TRUE)

Dentro do corpo

alternative <- match.arg(alternative)

Cortando um vetor por quantil

cut_by_quantile <- function(x, n, na.rm, labels, interval_type) {
  probs <- seq(0, 1, length.out = n + 1)
  quantiles <- quantile(x, probs, na.rm = na.rm, names = FALSE)
  right <- switch(interval_type, "(lo, hi]" = TRUE, "[lo, hi)" = FALSE)
  cut(x, quantiles, labels = labels, right = right, include.lowest = TRUE)
}

x: Vetor numérico a ser cortado
n: Número de categorias para dividir x
na.rm: Remover valores ausentes?
labels: Rótulos de texto para as categorias
interval_type: Os intervalos abrem à esquerda ou à direita?

Pesos do coração de gatos

Um strip plot dos pesos do coração de gatos. O intervalo vai de 3 a 20 gramas.

quantile(cats$Hwt)

    0%    25%    50%    75%   100% 
 6.300  8.950 10.100 12.125 20.500

¹ data(cats, package = "MASS")

Cortando por quantil

O strip plot do slide anterior recebeu cores: pontos vermelhos à esquerda, depois verdes, turquesa e roxos à direita.

cut(x, quantile(x))

Vamos praticar!

Introdução à Escrita de Funções em R