Pacotes miojo - como fazer um pacote no R em 3 minutos [atualizado]

Passo 1: Crie um projeto de pacote no R

• Use a função usethis::create_package("nomeDoPacote")
• Escreva o nome do seu pacote. O nome do pacote não pode ter espaços, underline (_) nem hífen (-) nem começar com números.

Ao fazer isso, o {usethis} abrirá uma nova tela do RStudio, já na estrutura de pacote!

Na tela em que você escreveu usethis::create_package(), o console ficará assim:

Obs: cuidado para não criar um pacote dentro de um repositório Git (por exemplo, dentro de um projeto que você já está trabalhando). Isso pode dar problemas de conflito.

Passo 2: Configurar Git

Rode usethis::use_git() e confirme nas duas perguntas que serão feitas a você

Sua sessão será reiniciada, e o Git está configurado 🎉

Passo 3: configure o GitHub

Rode usethis::use_github() e confirme a pergunta que será feita. Aqui estou assumindo que você tem o Git/GitHub configurado na sua máquina. Se não estiver, siga o fluxo do livro Happy Git With R.

Se tudo der certo, seu pacote já estará disponível no seu GitHub!

Passo 4: Crie sua função

Exemplo:

#' Soma 2
#'
#' Recebe um vetor de números e retorna um vetor de números somando dois
#'
#' @param x vetor de números.
#'
#' @export
soma_2 <- function(x) {
  x + 2
}

1. Crie a função dentro de um arquivo com extensão .R na pasta R . Se quiser, você pode usar a função usethis::use_r() .
2. As informações que começam com #' acima da função servem para documentar. Nesse caso,
   • a primeira linha é o título
   • a segunda linha é a descrição
   • a parte que começa com @param descreve o que é o parâmetro de entrada
   • a parte que começa com @export diz para o pacote que essa função deve estar disponível para o usuário quando ele rodar library(nomeDoPacote).

Passo 5: document, commit e push!

1. Rode devtools::document().
2. Commite suas alterações.
3. Dê um push!

Se não saba o que é commitar e pushar, veja o artigo do Athos sobre o uso do git e do GitHub.

Passo 6: Instalar o pacote em outra máquina

1. Mande o nome do seu usuário do GitHub e o nome do seu pacote para sua migue.
2. Peça para ela rodar:

remotes::install_github('usuario/nomeDoPacote')

1. Agora ela poderá usar sua função!

library(nomeDoPacote)
soma_2(1:10)
# [1]  3  4  5  6  7  8  9 10 11 12

Você também pode ver o help da função com ?soma_2:

FIM!

Conclusões

• Agora você não tem desculpa para não empacotar suas soluções em R.
• Esse tutorial é incompleto! Para acessar mais detalhes, veja http://r-pkgs.had.co.nz, elaborado por você sabe quem.

Outras pequenas dicas práticas

• Use sempre devtools::check() para checar se seu pacote está 100% bem construído.
• Use usethis::use_package() para usar funções de outros pacotes.
• Sempre use os :: para chamar as funções e nunca rode library() ou require() dentro de um pacote.
• Use usethis::use_mit_license() para adicionar um arquivo LICENSE ao seu pacote.
• Use usethis::use_data() para adicionar dados ao seu pacote.
• Use usethis::use_vignettes() para escrever um tutorial sobre seu pacote, igual a esse do dplyr, por exemplo.

É isso. Happy coding ;)