Function R: O que é e como criar uma função R

A linguagem de pro­gra­ma­ção R é usada em diversas áreas que executam análises de dados e es­ta­tís­ti­cas. Entre os conceitos mais im­por­tan­tes da pro­gra­ma­ção em R está a função R (function R). Ela pode ajudar você a deixar o seu código limpo e modular.

Quando usar functions in R?

A chamada function R ou, em português, função R, é usada para es­tru­tu­rar, organizar ou reu­ti­li­zar um código. Em especial, ela é capaz de de­sem­pe­nhar análises complexas e processar dados em larga escala, além de também poder ser usada para criar análises per­so­na­li­za­das. Ademais, estes são os be­ne­fí­cios de se criar ou utilizar funtions in R:

• Abstração: Uma função R permite o en­cap­su­la­mento de processos e de cálculos complexos, em uma interface única e de fácil en­ten­di­mento. Assim, ela facilita tanto a ma­nu­ten­ção quanto a leitura de um código.
• Reu­ti­li­za­ção: Uma função R pos­si­bi­lita a execução de blocos de código es­pe­cí­fi­cos re­pe­ti­da­mente, sem que estes precisem ser re­es­cri­tos múltiplas vezes. Dessa forma, uma funcion R ajuda a eco­no­mi­zar tempo e reduz pos­si­bi­li­da­des de erros.
• Mo­du­la­ri­dade: Com uma função R, você consegue dividir um projeto grande em partes menores, fa­ci­li­tando a ad­mi­nis­tra­ção do mesmo.

Sintaxe de functions in R

A estrutura de funções R costuma ser con­sis­tente, seguindo um padrão claro. Uma função R possui os seguintes com­po­nen­tes prin­ci­pais:

• Nome da função: Costuma indicar a tarefa a ser de­sem­pe­nhada.
• Ar­gu­men­tos: Variáveis ou valores trans­mi­ti­dos à função e pro­ces­sa­dos por ela. Uma função pode ter vários ar­gu­men­tos ou não conter argumento nenhum. Também é possível utilizar valores padrão para funções R.
• Corpo da função: Contém o código a ser executado por ela, a ser escrito entre chaves. Um código é capaz de acessar e processar ar­gu­men­tos.
• Valor de retorno: A maioria das funções R faz uso de return() para retornar o valor que re­pre­senta o resultado de um cálculo. Um valor de retorno pode ser usado para aplicar o resultado de uma função a outras partes de um código.

Acompanhe, abaixo, um exemplo simples de uma function R criada para somar dois números:

my_add <- function(a, b) {
    result <- a + b
    return(result)
}

No código acima, my_add é o nome da função, já a e b são os ar­gu­men­tos. O corpo da função executa a adição e return(result) retorna o resultado. Por fim, a definição da função R é apre­sen­tada pela palavra-chave function.

Uma função também pode conter ar­gu­men­tos com valores pre­de­fi­ni­dos, a serem usados quando nenhum outro argumento é informado. Valores padrão para a função R apre­sen­tada acima seriam os seguintes:

my_add <- function(a = 1, b = 2) {
    result <- a + b
    return(result)
}

Assim, se a função for chamada sem que nenhum argumento seja informado, esta retornará o valor 3.

Functions in R pré-ins­ta­la­das

A linguagem de pro­gra­ma­ção R tem uma ampla coleção de funções pré-ins­ta­la­das. Estas são chamadas de comandos R e podem ser usadas para as mais diversas fi­na­li­da­des. Em alguns casos, funções R também podem ser de­sem­pe­nha­das por ope­ra­do­res R. Quando isso ocorre, elas são subs­ti­tuí­das pelo operador +.

A menos que você esteja somente começando a aprender sobre pro­gra­ma­ção, já deverá estar fa­mi­li­a­ri­zado com algumas das funções abaixo:

• mean(): Calcula a média dos números
• plot(): Função plot R (r function plot) que cria gráficos e tabelas
• read.csv(): Lê dados de um arquivo CSV
• toupper(): Converte todos os ca­rac­te­res de uma R string em ca­rac­te­res maiús­cu­los
• sum(): Calcula a soma dos números
• print(): Apresenta valores no console

Observe, abaixo, exemplo de como fazer uso da function Rmean, pré-instalada. A variável result, presente no final do código, apresenta a média de todos os números do vetor R numbers.

numbers <- c(2, 4, 6, 8, 10)
result <- mean(numbers)

Como criar functions in R?

Criar funções R próprias é parte fun­da­men­tal da pro­gra­ma­ção em R, uma vez que suas criações serão es­pe­ci­fi­ca­mente adaptadas às suas ne­ces­si­da­des. Para escrever uma function R, basta que você com­pre­enda a sintaxe dessa linguagem e defina os ar­gu­men­tos cor­re­ta­mente.

Observe, abaixo, um exemplo de função R per­so­na­li­zada simples, pro­gra­mada para retornar o valor de um número:

my_abs <- function(x) {
    if (x < 0) {
        return(-x)
    } else {
        return(x)
    }
}

A função R apre­sen­tada acima leva em con­si­de­ra­ção o argumento x. No corpo dela, a de­cla­ra­ção if verifica se o número é positivo ou negativo. O valor retornado é, então, de­vi­da­mente ajustado.

Como usar uma function R própria?

Após criar uma função, adicione-a ao seu código em R. Para tanto, chame seu nome e informe os ar­gu­men­tos ne­ces­sá­rios. O uso de uma função R própria não difere do uso de uma função R pré-definida.

Aqui, colocamos em uso da função my_abs que acabamos de criar:

result <- my_abs(-5)
print(result)

Ao exe­cu­tar­mos o código do exemplo, o resultado 5 será apre­sen­tado. Ele prova que o cálculo do valor absoluto feito pela função está correto.