Roxygen pode ignorar as funções não usuários?

Question

Acabei de começar a brincar com o roxygen Pacote e estou muito feliz com os resultados até agora. No entanto, eu estava me perguntando, existe uma maneira de especificar para roxygen que deve ignorar certas funções que não são acessíveis ao usuário?

Especificamente, eu prefiro não ter um .Rd Arquivo pop -up porque estou usando o .onLoad() gancho no meu pacote. Esta função já está documentada no base Pacote para que não haja razão para eu documentar novamente.

Answer 1

Bem, eu finalmente encontrei e naveguei na lista Roxygen-Devel em R-forge Ver quando isso seria implementado e parece já estar na versão do Roxygen que está em cran. A chave é especificar use.Rd2=TRUE Ao ligar roxygenize(). Sob esse modo, o Roxygen ignorará a criação de documentação para quaisquer funções que não sejam precedidas pelos comentários do Roxygen.

Answer 2

Isso está na lista de tarefas - na próxima versão, apenas funções com a documentação do Roxygen criarão arquivos MAN.

Answer 3

Use o campo de palavra -chave interno (ou seja @keywords internal) para remover a função da documentação e disponibilizá -la apenas para usuários experientes. Fonte: vinheta roxygen2.