Construindo o esqueleto de um pacote R
Source:vignettes/construindo_pacote.Rmd
construindo_pacote.RmdNessa seção, veremos como construir um pacote R usando o RStudio. Iremos solicitar a instalação de alguns pacotes, mesmo não utilizando todos para esse momento.
pkgs <- c("knitr", "devtools", "usethis", "roxygen2", "pkgdown", "pkgbuild")
install.packages(pkgs)Descriminaremos a importância de cada pacote na tabela a seguir. Para essa primeira versão, deixaremos claro que o desenvolvimento de pacotes será usado de acordo com as configurações do sistema operacional Windows. Assim, precisaremos instalar uma outra ferramenta que é o rtools.
| Pacote | Funções | Objetivo |
|---|---|---|
| knitr | ||
| devtools | ||
release |
||
uses_testthat |
||
test |
||
test_coverage |
||
test_coverage_file |
||
create |
||
install_github |
||
| roxygen2 | ||
| usethis | ||
use_pkgdown |
||
use_build_ignore |
||
use_cran_comments |
||
use_badge |
||
use_cran_badge |
||
use_coverage |
||
use_data_raw |
||
use_data |
||
use_description |
||
use_git |
||
use_travis_badge |
||
use_git |
||
use_version |
||
use_vignette |
||
github_actions |
||
github_token |
||
use_testthat |
||
use_news_md |
||
use_readme_rmd |
||
| pkgdown | ||
build_site |
||
build_favicons |
||
build_article |
||
build_articles |
||
| pkgbuild |
Por fim, precisamos fazer o download para o \(\LaTeX\), para desenvolvermos a documentação do pacote. Caso não deseje fazer essa instalação, uma alternativa é instalar o pacote tinytex.
utils::install.packages("tinytex")Lembre-se que se já tiver o \(\LaTeX\) instalado não é necessário instalar tinytex, e até não recomendado instalar para não gerar conflito com a versão que já tem instalada.
Para carregar e anexar esses pacotes, use as linhas de código a seguir.
### Funcao carregar
carregar <- function(package){
return(suppressMessages(require(package, character.only = TRUE)))
}
### Carregando
pkgs <- cbind(pkgs)
sapply(pkgs, carregar)Esqueleto básico de um pacote R
A estrutura básica de um pacote pode ser apresentado a seguir.
Os arquivos e diretórios básicos são:
-
DESCRIPTION: Arquivo que contém as informações básicas do pacote, tais como:
- Nome do pacote;
- Título do pacote;
- Data;
- Autor e mantenedor;
- Descrição do pacote;
- Licença;
- Pacotes dependentes;
- Pacotes sugeridos; Alguns desses campos citados acima, não são obrigatórios. Veremos mais a frente.
- NAMESPACE: Esse arquivo informa quais as funções do seu pacote que serão exportadas, visíveis aos usuários do pacote, e quais funções de outros pacotes importaremos, quando for a necessidade.
- R/: Esse diretório armazena as rotinas “.R” do seu pacote. Dizemos que é o cérebro do pacote, quando a linguagem está toda escrita em R.
- man/: Esse diretório armazena os arquivos de ajuda do pacote. Descreve como as funções de um pacote devem ser utilizadas, apresentando inclusive exemplos.
Construindo o pacote R pelo RStudio
Para construir o esqueleto básico de um pacote, usando o RStudio, siga os passos pelo vídeo abaixo.
Passos no RStudio: File > New Project... > New Directory > R package. Insira o nome do pacote e armazene o projeto em um diretório desejado. Nesse momento, poderíamos já ter adicionado um repositório GitHub ao pacote. Deixaremos essa parte para as seções seguintes.
Se desejar criar um pacote por linha de comando, use usethis::create_package. E se ainda não desejar utilizar o R, acesse Desenvolvimentos de pacote em R, e baixe as apostilas disponíveis.