mention vcr as an alternative to precomputing vignettes #964
+15
−29
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpadge
approved these changes
Oct 17, 2025
maelle
requested review from
beatrizmilz and
yabellini
and removed request for
a team
beatrizmilz
reviewed
Oct 27, 2025
There was a problem hiding this comment.
Hi @maelle ! I have checked the PT versions comparing with the EN versions.
I was not sure about apparently an URL in one of the edits, but I left a comment there.
| Você só precisa se preocupar com a implementação automática (*automatic deployment*) do seu site até a aprovação e a transferência do repositório do seu pacote para a organização ropensci; de fato, depois disso, um site pkgdown será criado para o seu pacote após cada *push* para o repositório do GitHub. Você pode encontrar o status dessas compilações em `https://dev.ropensci.org/job/package_name` por exemplo [para `magick`](https://dev.ropensci.org/job/magick); e o site em `https://docs.ropensci.org/package_name` por exemplo [para `magick`](https://docs.ropensci.org/magick). A construção do site usará seu arquivo de configuração pkgdown, se você tiver um, exceto para o estilo que usará o arquivo [de modelo do pacote`rotemplate`](https://github.com/ropensci-org/rotemplate/). O site resultante terá uma barra de pesquisa local. Pedimos que informe erros, perguntas e solicitações de recursos sobre a implementação automática em <https://github.com/ropensci/docs/> e sobre o modelo em <https://github.com/ropensci/rotemplate/>. | ||
|
|
||
| *Se as vinhetas do seu pacote precisarem de credenciais (chaves de API, tokens, etc.) para serem ativadas, talvez você queira [renderizar as vinhetas previamente](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/), já que as credenciais não podem ser usadas no servidor de documentos.* | ||
| *Se as vinhetas do seu pacote precisarem de credenciais (chaves de API, tokens, etc.) para serem ativadas, talvez você queira [renderizar as vinhetas previamente](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/)ou para [armazenar respostas em cache](https://docs.ropensci.org/vcr/reference/setup_knitr.html), já que as credenciais não podem ser usadas no servidor de documentos.* |
There was a problem hiding this comment.
Suggested change
| *Se as vinhetas do seu pacote precisarem de credenciais (chaves de API, tokens, etc.) para serem ativadas, talvez você queira [renderizar as vinhetas previamente](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/)ou para [armazenar respostas em cache](https://docs.ropensci.org/vcr/reference/setup_knitr.html), já que as credenciais não podem ser usadas no servidor de documentos.* | |
| *Se as vinhetas do seu pacote precisarem de credenciais (chaves de API, tokens, etc.) para serem ativadas, talvez você queira [renderizar as vinhetas previamente](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/) ou [armazenar as respostas em cache](https://docs.ropensci.org/vcr/reference/setup_knitr.html), já que as credenciais não podem ser usadas no servidor que renderiza a documentação.* |
|
|
||
| - Para exemplos de funções, use a tag roxygen2 `examplesIf` com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)` | ||
| - Para vinhetas, pré-compile se forem necessárias ferramentas/dados/credenciais especiais que não estão disponíveis em servidores de compilação genéricos (consulte https://ropensci.org/blog/2019/12/08/precompute-vignettes/) ou use a variável `IN_PKGDOWN` com a opção knitr eval, por exemplo | ||
| - Para exemplos de funções, use a tag roxygen2 `examplesIf` com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)`. Exemplo: [gtexr](https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e935d4155570c5960d1fdb/R/get_service_info.R#L14) (consulte também a seção [docs da tag roxygen2](https://roxygen2.r-lib.org/articles/rd.html?q=examplesIf#examples)). |
There was a problem hiding this comment.
Suggested change
| - Para exemplos de funções, use a tag roxygen2 `examplesIf` com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)`. Exemplo: [gtexr](https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e935d4155570c5960d1fdb/R/get_service_info.R#L14) (consulte também a seção [docs da tag roxygen2](https://roxygen2.r-lib.org/articles/rd.html?q=examplesIf#examples)). | |
| - Para exemplos de funções, use a tag `examplesIf` do roxygen2 com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)`. Exemplo: [gtexr](https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e935d4155570c5960d1fdb/R/get_service_info.R#L14) (consulte também a [documentação da tag do roxygen2](https://roxygen2.r-lib.org/articles/rd.html?q=examplesIf#examples)). |
| - Para exemplos de funções, use a tag roxygen2 `examplesIf` com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)` | ||
| - Para vinhetas, pré-compile se forem necessárias ferramentas/dados/credenciais especiais que não estão disponíveis em servidores de compilação genéricos (consulte https://ropensci.org/blog/2019/12/08/precompute-vignettes/) ou use a variável `IN_PKGDOWN` com a opção knitr eval, por exemplo | ||
| - Para exemplos de funções, use a tag roxygen2 `examplesIf` com a variável `IN_PKGDOWN`, por exemplo, `#' @examplesIf identical(Sys.getenv(“IN_PKGDOWN”), “true”)`. Exemplo: [gtexr](https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e935d4155570c5960d1fdb/R/get_service_info.R#L14) (consulte também a seção [docs da tag roxygen2](https://roxygen2.r-lib.org/articles/rd.html?q=examplesIf#examples)). | ||
| - Para vinhetas, pré-compile se forem necessárias ferramentas/dados/credenciais especiais que não estão disponíveis em servidores de compilação genéricos (consulte https://ropensci.org/blog/2019/12/08/precompute-vignettes/) ou use a variável `IN_PKGDOWN` com a opção knitr eval. Exemplo: 60d1fdb/vignettes/gtexr.Rmd#L16 ou: |
There was a problem hiding this comment.
Hi! Is 60d1fdb/vignettes/gtexr.Rmd#L16 an external URL? If it is, for me is showing 404. If it's not, I'm not sure if I understood the context.
|
|
||
| - `examplesIf`:https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e935d4155570c5960d1fdb/R/get_service_info.R#L14 (veja também a documentação da tag roxygen2: https://roxygen2.r-lib.org/articles/rd.html?q=examplesIf#examples) | ||
| - Vignette, opção knitr eval: https://github.com/ropensci/gtexr/blob/592ac781672f07eb67e | ||
| - No caso de vinhetas/artigos que executam solicitações HTTP, você pode usar pacotes específicos do R, como [vcr](https://docs.ropensci.org/vcr/reference/setup_knitr.html) para armazenar as respostas em cache. Exemplo: [nettskjemar](https://github.com/capro-uio/nettskjemar/blob/261260e2510f51d8dc0af5e4c9c386a7e459de4b/vignettes/metadata.Rmd#L22). |
There was a problem hiding this comment.
Suggested change
| - No caso de vinhetas/artigos que executam solicitações HTTP, você pode usar pacotes específicos do R, como [vcr](https://docs.ropensci.org/vcr/reference/setup_knitr.html) para armazenar as respostas em cache. Exemplo: [nettskjemar](https://github.com/capro-uio/nettskjemar/blob/261260e2510f51d8dc0af5e4c9c386a7e459de4b/vignettes/metadata.Rmd#L22). | |
| - No caso de vinhetas/artigos que executam requisições HTTP, você pode usar pacotes específicos do R, como o [vcr](https://docs.ropensci.org/vcr/reference/setup_knitr.html) para armazenar as respostas em cache. Exemplo: [nettskjemar](https://github.com/capro-uio/nettskjemar/blob/261260e2510f51d8dc0af5e4c9c386a7e459de4b/vignettes/metadata.Rmd#L22). |
| No CRAN, ignore quaisquer testes (`skip_on_cran()`) e exemplos (`dontrun`) que exijam credenciais. | ||
|
|
||
| [Gere previamente as vinhetas](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/) que requerem credenciais. | ||
| [Gere previamente as vinhetas](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/) que requerem credenciais, ou use [vcr](https://docs.ropensci.org/vcr/reference/setup_knitr.html). |
There was a problem hiding this comment.
Suggested change
| [Gere previamente as vinhetas](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/) que requerem credenciais, ou use [vcr](https://docs.ropensci.org/vcr/reference/setup_knitr.html). | |
| [Gere previamente as vinhetas](https://ropensci.org/technotes/2019/12/08/precompute-vignettes/) que requerem credenciais, ou use o pacote [vcr](https://docs.ropensci.org/vcr/reference/setup_knitr.html). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #944
Translations to come only after reviews of the English text.