как перечислить виньетки в пакете в README или связанные - PullRequest
Новая
       87

как перечислить виньетки в пакете в README или связанные

0 голосов
/ 28 марта 2020

В нескольких пакетах, последний пакет matlib на github, https://github.com/friendly/matlib, у меня есть файл README. {Md, Rmd}, который говорит что-то вроде

Небольшая коллекция виньеток теперь доступна. Используйте browseVignettes("matlib"), чтобы увидеть их.

Я хотел бы заменить или добавить к этому в README список имен виньеток и их заголовков.

Самое близкое, что я могу найти к информации, которую я хочу в README, - это результат > vignette(package= "matlib"), который выглядит следующим образом: 

 Vignettes in package ‘matlib’:

 eigen-ex1               Eigenvalues and Eigenvectors: Properties
                         (source, html)
 eigen-ex2               Eigenvalues: Spectral Decomposition (source,
                         html)
 det-ex2                 Evaluation of determinants (source, html)
 ginv                    Generalized inverse (source, html)
 gramreg                 Gram-Schmidt Orthogonalization and Regression
                         (source, html)
 inv-ex1                 Inverse of a matrix (source, html)
 inv-ex2                 Matrix inversion by elementary row operations
                         (source, html)
 det-ex1                 Properties of determinants (source, html)
 linear-equations        Solving Linear Equations (source, html)

Но я хочу зафиксировать результат этого в кусок или что я могу использовать непосредственно в README. Если я создаю сайт пакета с pkgdown, я получаю полученные ссылки на виньетки в разделе ** Articles *, но у меня все еще нет списка имен и названий виньеток, поскольку я могу использовать их напрямую.

1 Ответ

0 голосов
/ 07 апреля 2020

Для записи, tools::getVignetteInfo() дает мне то, что я хочу 

> vinfo <- tools::getVignetteInfo("ggplot2")

> vinfo
     Package   Dir                            Topic                
[1,] "ggplot2" "C:/R/R-3.6.3/library/ggplot2" "ggplot2-specs"      
[2,] "ggplot2" "C:/R/R-3.6.3/library/ggplot2" "extending-ggplot2"  
[3,] "ggplot2" "C:/R/R-3.6.3/library/ggplot2" "ggplot2-in-packages"
     File                      Title                      
[1,] "ggplot2-specs.Rmd"       "Aesthetic specifications" 
[2,] "extending-ggplot2.Rmd"   "Extending ggplot2"        
[3,] "ggplot2-in-packages.Rmd" "Using ggplot2 in packages"
     R                       PDF                       
[1,] "ggplot2-specs.R"       "ggplot2-specs.html"      
[2,] "extending-ggplot2.R"   "extending-ggplot2.html"  
[3,] "ggplot2-in-packages.R" "ggplot2-in-packages.html"
>
...