Como escapar % da programação de Roxygen alfabetizada?
-
23-09-2019 - |
Pergunta
O valor padrão de um parâmetro da minha função contém um "%". Isso parece ser um problema para o Roxygen, ele produz muitos avisos e a verificação de R CMD falha ao tentar criar documentação no látex.
Como posso fazer essa função (e sua documentação) funcionar? Usar %% ou % em vez de % não ajuda.
#' Test escape \% from in-source documentation (roxygen).
#'
#' What happens when parameters contain special latex characters?
#'
#' @param x unsuspicious parameter
#' @param format sprintf format string (default "\%5.0f")
#'
#' @return formatted string
#' @export
#' @author Karsten Weinert
testroxy <- function(x, format = "%5.0f") {
sprintf(format,x)
}
Solução
Encontrei uma solução.
Em vez de conectar o MediaController com uma instância real do MediaPlayer, você pode simplesmente implementar a interface MediaPlayerControl com qualquer classe e conectar o serviço com o widget MediaController através dos métodos de interface.
Outras dicas
O código semelhante ao da pergunta funciona para mim sem problemas e gera a documentação correta. Como dizem vários comentários, o motivo deve ser que estou usando o pacote roxygen2. Então, basta usar o Roxygen2 e depois escapar "%" na documentação usando barragem:
#' The percentage sign is written in the documentation like this: \%.