Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation issue: tibble shows unprintable characters in vignette #1085

Closed
billdenney opened this issue Apr 26, 2023 · 6 comments · Fixed by #1164
Closed

Minor documentation issue: tibble shows unprintable characters in vignette #1085

billdenney opened this issue Apr 26, 2023 · 6 comments · Fixed by #1164
Assignees
Milestone

Comments

@billdenney
Copy link
Contributor

On my computer, the tibble in the second code block seems to show some ASCII coloring characters:

https://mrgsolve.org/docs/articles/extra/time-after-dose.html#tad-calculated-as-runtime-argument

I think that it's happening here, but I'm not sure why it's happening:

```{r, message = FALSE, warning=FALSE}
library(mrgsolve)
library(dplyr)
mod <- modlib("pk1", req = "")
mod %>%
ev(amt = 100, ii = 4, addl = 3, time = 2) %>%
mrgsim(tad = TRUE, add = c(3.888,5.91)) %>%
as_tibble() %>%
head(n = 10)
```

@kylebaron
Copy link
Collaborator

Thanks, @billdenney ; looks like some other text / code that I wanted output isn't showing up. I'll look into it; maybe some tweak needed to whatever is supporting pkgdown?

@billdenney
Copy link
Contributor Author

When I looked at the code you have, I don't see anything that looks unusual to me. The vignette itself, globals.R, and the pkgdown settings all seem benign.

@kyleam
Copy link
Contributor

kyleam commented Apr 26, 2023

Perhaps the crayon ANSI codes getting through is due to the lack of a # prefix: r-lib/pkgdown#1965

If that's the case, the vignettes could be changed to either

  • use a comment prefix for the output
  • disable crayon highlighting options(crayon.enabled = FALSE)

@billdenney
Copy link
Contributor Author

That looks like the culprit.

@kylebaron
Copy link
Collaborator

Yeah; I like to change comment to .; that must be it. Thanks @kyleam and @billdenney .

@kylebaron
Copy link
Collaborator

The special comment character was reverted to the default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants