[R-pkg-devel] Lost Braces in R Markdown File
Duncan Murdoch
murdoch@dunc@n @end|ng |rom gm@||@com
Thu Apr 10 04:41:07 CEST 2025
[I sent this only to Jarrett on my first attempt, this was meant to go
to the list.]
The syntax for the \item macro has two arguments, so the text "A matrix
containing only those specimen that have ..." is in braces that are
unnecessary. That's why you got the note, because check thinks that was
unintentional and wanted to point it out to you. It's legal, so it's
not an error, just a note.
If I look at the display of the help page ?aminoAcidFun, I think it's
right that something is wrong. The formatting near the end of the Value
section looks messed up.
Duncan Murdoch
On 2025-04-09 7:57 p.m., Jarrett Phillips wrote:
> Hello!
>
> I recently ran R CMD CHECK via devtools::check_built() on my CRAN package
> 'VLF'. See: https://cran.r-project.org/web/checks/check_results_VLF.html.
>
> The notes I received pertain to the below, but I am unsure exactly how to
> resolve the issue after googling a bit. Any ideas?
>
> Thanks.
>
> Cheers,
>
> Jarrett
>
> -----
>
> Version: 1.1
> Check: Rd files
> Result: NOTE
> checkRd: (-1) aminoAcidFun.Rd:37: Lost braces
> 37 | \item{ownVLFreduced}{ownVLFMatrix}{A matrix containing only
> those specimen that have VLFs as well as the amino acids at the
> positions that contain VLFs and NAs in all other positions of the
> sequence. Only appears if own is not NULL.}
> | ^
> checkRd: (-1) vlfFun.Rd:36: Lost braces
> 36 | \item{ownVLFreduced}{ownVLFMatrix}{A matrix containing only
> those specimen that have VLFs as well as the nucleotides at the
> positions that contain VLFs and NAs in all other positions of the
> sequence. Only appears if own is not NULL.}
> |
>
> [[alternative HTML version deleted]]
>
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel
More information about the R-package-devel
mailing list