Como adicionar uma vinheta a um pacote no RStudio

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br


[Esteartigofoipublicadopelaprimeiravezem[Thisarticlewasfirstpublishedon triKnowBits, e gentilmente contribuiu para os R-blogueiros]. (Você pode relatar um problema sobre o conteúdo desta página aqui)


Deseja compartilhar seu conteúdo com R-blogueiros? clique aqui se você tiver um blog ou aqui se não tiver.

As vinhetas do pacote R são maneiras fáceis de usar para demonstrar os recursos do seu pacote. Eles também podem ser uma documentação útil para sua própria referência ao modificar o pacote no futuro – “o que eu estava pensando lá?”

A maneira mais fácil de criar uma vinheta no RStudio é usando Arquivo | Novo arquivo | R Markdown | Do modelo | Vinheta de pacote (HTML). Escreva o seu documento RMarkdown. {Nota: Certifique-se de copiar o “título” da sua vinheta para onde “Título da vinheta” aparece na seção abaixo:

vinheta:>
% VignetteIndexEntry {Título da vinheta}

}

Depois disso, construa seu pacote. Mas se você usar o procedimento típico para desenvolver um pacote no RStudio, sua vinheta não aparecerá. [Pulling hair out] Deixe-me explicar.

Meu procedimento típico para Construirpacote de ing Meu pacote no RStudio é usar dois itens de menu no Construir painel

  • Verifica, então
  • Instalar e reiniciar

Verifica garante que tudo saia corretamente. Isso inclui o processamento de vinhetas no myPackage / vinhetas diretório, que você pode ver em várias áreas do VerificaOutput saída nesse painel:

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br


– instalando o pacote para criar vinhetas
v criar vinhetas (7.4s)

* verificação de arquivos em “vinhetas” … OK

* verificação de dependências não declaradas nas vinhetas … OK
* verificação de vinhetas de pacotes em ‘inst / doc’ … OK
* verificação da reconstrução das saídas da vinheta … OK

Quando Verificação R CMD bem-sucedida aparecer na parte inferior dessa saída, clique em Instalar e reiniciar no Construir painel novamente e Meu pacote serão recompilados, recarregados e prontos para uso … todos, exceto as vinhetas, porque quando você as procurar, elas não estarão lá:

> browseVignettes (“myPackage”)
Nenhuma vinheta encontrada por browseVignettes (“myPackage”)
>

Acontece que, de acordo com a documentação on-line levemente desatualizada do RStudio, esse comportamento é esperado porque, presumivelmente, os desenvolvedores não querem se preocupar com vinhetas no típico código / Instalar e reiniciar / recodificar ciclo de desenvolvimento [I get that]; a saber:

O “Construir e recarregar” do RStudio não cria vinhetas para economizar tempo.

{Nota: “Compilar e recarregar” foi renomeado como “Instalar e reiniciar” na versão 1.2.5042 do RStudio de hoje.}

Não. Vá para o painel Build e, no menu suspenso “More”, escolha “Build Source Package”. Isso criará um arquivo com a extensão .tar.gz, que você pode distribuir para outras pessoas. Você o instala usando “Pacotes | Instalar | Instale a partir de… | Arquivo de pacote ”. – user2554330 25 de março de 18 às 19:10

Isso funcionou muito bem. Obrigado ao RStudio pelo software que tende a simplesmente fazê-lo de uma maneira ou de outra, e obrigado ao usuário2554330 por explicar como fazê-lo para vinhetas.

Leia Também  Por que R? Seminário on-line sobre exames R / para testes de e-learning e outros



Se você chegou até aqui, por que não inscreva-se para atualizações do site? Escolha o seu sabor: e-mail, twitter, RSS ou facebook …



cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br