37 Construindo pacotes

Os passos básicos para construção de um pacote são listados a seguir.

1.

Abra uma sessão do R e coloque na sua área de trabalho todas as funções e conjunto de dados que deseja incluir no pacote. Tome o cuidado de remover todos os demais objetos que não devem ser incluídos no pacote.

2.

No "prompt"do R use package.skeleton() para gerar um diretório com a estrutura de diretórios mínima requerida para pacotes. Por exemplo, se o seu pacote se chamar meupack use o comando abaixo. Certifique-se que o diretório a ser criado ainda não existe no seu diretório de trabalho.

> package.skeleton(name="meupack")

3.

No diretório criado você vai encontrar:

• O arquivo DESCRIPTION que contém uma descrição básica do seu pacote. Edite este arquivo tomando cuidado para não alterar a estrutura do mesmo
• O subdiretório data que contém os conjuntos de dados que estavam em seu "workspace". Voce não precisa fazer nada neste diretório.
• O subdiretório man que contém a documentação de seu pacote com um arquivo para cada função e conjunto de dados de seu pacote. Abra cada um dos arquivos em um editor de arquivos texto e edite a documentação, preservando o formato do arquivo.
• O subdiretório R contém arquivos com as funções em R de seu pacote. Voce não precisa fazer nada neste diretório a menos que vá usar código compilado em seu pacote (ver mais detalhes a seguir).
• O subdiretório src somente será usado caso o seu pacote vá usar códigos em C, C++ ou Fortran. Se este for o caso você deve colocar neste subdiretório os arquivos fontes nestas linguagens.

4.

Caso o seu pacote vá usar códigos em C, C++ ou Fortran coloque um arquivo com o nome zzz.R no subdiretório R com o seguinte conteúdo

      .onLoad <- function(libname, pkgname)
      {
        library.dynam("Embrapa", package = pkgname, lib.loc = libname)
      }

NOTA: o gancho .First.lib usado em versões antigas do R para esta finalidade está obsoleto e não é mais chamado em pacotes com arquivo NAMESPACE (como os gerados por package.skeleton()); use .onLoad() como acima.

5.

Para testar o seu pacote você pode usar na linha de comando:

      R CMD check meupack

6.

Para montar o arquivo fonte .tar.gz de distribuição do pacote use o comando a seguir. O arquivo criando pode ser usado de forma padrão para instalar pacotes no R a partir do arquivo fonte do pacote.

      R CMD build meupack

Durante o curso foi demonstrado como construir pacotes no R, usando como exemplo a própria construção de um pacote Embrapa reunindo as funções e conjuntos de dados utilizados nas aulas.

Os passos listados aqui são bastante simplificados e são simplesmente o mínimo necessário para criação de pacotes. Diversos outros recursos estão disponíveis e para maiores e mais detalhadas informações sobre como construir pacotes consulte o manual Writing R Extensions.