Home

Passos a seguir se você tem uma função nos repositórios nowcasting, site ou localmente e quer incorporá-la ao pacote

• Copiar o arquivo da função para a subpasta /R

• Incluir a parametrização da função:

  • Se estiver no RStudio: abrir o arquivo e posicionar o mouse dentro do código da função, clicar em Code > Insert roxygen skeleton. Um cabeçalho de roxygen2 vai ser acrescentado ou corrigido com os parâmetros atuais da função.
  • Editar o cabeçalho: Não deixar a descrição dos parâmetros vazia. Idealmente cada descrição é uma descrição real e curta do parâmetro -se é numérico, logical, o que o parâmetro faz etc. Em alguns casos estamos simplesmente duplicando o nome do parâmetro (ex: #' @param example example).
  • Eliminar os campos (as linhas) #' @return e #' @examples se esses campos vão ficar vazios. Se for manter, o return é a descrição do tipo de objeto retornado pela função. O example deve ser um exemplo de código reproduzível e tem que ser curto e rodar rapidamente.
  • Incluir as funções que a função importa acrescentando linhas com a seguinte sintaxe: #' @importFrom nome_do_pacote funcao1 funcao2

• Criar a documentação rodando devtools::document(). Um arquivo .Rd vai ser criado na subpasta /man. O NAMESPACE do pacote talvez seja editado para refletir as funções importadas.

• Agora deve ser possível trabalhar localmente com o pacote, carregar ele usando devtools::load_all()

• Para saber se o pacote está em boa forma, é possível rodar os checks com devtools::check(). A função indicará se há algum erro, warning ou nota que precise ser corrigida. Se for algo fora de seu alcance ou tiver erros que não está sendo fácil de corrigir, pode incluir como issue para alguém da equipe ver.

• Fazer commit e push dos arquivos .R, .Rd e do NAMESPACE