search

wilkelab / ggtext

Improved text rendering support for ggplot2
https://wilkelab.org/ggtext/
GNU General Public License v2.0
651 stars 37 forks source link

fix documentation links #20

Closed tjmahr closed 4 years ago

tjmahr commented 4 years ago

I was not able to use remotes to install the package. And I was not able to build the package locally from the git repository.

==> Rcmd.exe INSTALL --no-multiarch --with-keep.source ggtext

* installing to library 'C:/Users/Tristan/Documents/R/win-library/3.5'
* installing *source* package 'ggtext' ...
** using staged installation
** R
** byte-compile and prepare package for lazy loading
** help
*** installing help indices
converting help for package 'ggtext'
element_markdown                        html      finding HTML links ... done

finding level-2 HTML links ...
Error: unknown input format
* removing 'C:/Users/Tristan/Documents/R/win-library/3.5/ggtext'
* restoring previous 'C:/Users/Tristan/Documents/R/win-library/3.5/ggtext'

Exited with status 1.

The package installation worked when I disabled roxygen's markdown flag. That made me think it was the links. So I added namespace to the external functions and removes the redundant backticks in the links (links to functions are automatically converted to code). Now the package builds successfully.

==> Rcmd.exe INSTALL --no-multiarch --with-keep.source ggtext

* installing to library 'C:/Users/Tristan/Documents/R/win-library/3.5'
* installing *source* package 'ggtext' ...
** using staged installation
** R
** byte-compile and prepare package for lazy loading
** help
*** installing help indices
  converting help for package 'ggtext'
    element_markdown                        html      finding HTML links ... done

Rd warning: F:/Tristan/Documents/GitRepos2/ggtext/man/element_markdown.Rd:50: file link 'element_line' in package 'ggplot2' does not exist and so has been treated as a topic
Rd warning: F:/Tristan/Documents/GitRepos2/ggtext/man/element_markdown.Rd:81: file link 'margin' in package 'ggplot2' does not exist and so has been treated as a topic
    element_textbox                         html  
Rd warning: F:/Tristan/Documents/GitRepos2/ggtext/man/element_textbox.Rd:84: file link 'element_line' in package 'ggplot2' does not exist and so has been treated as a topic
Rd warning: F:/Tristan/Documents/GitRepos2/ggtext/man/element_textbox.Rd:111: file link 'margin' in package 'ggplot2' does not exist and so has been treated as a topic
    geom_richtext                           html  
Rd warning: F:/Tristan/Documents/GitRepos2/ggtext/man/geom_richtext.Rd:83: file link 'geom_label' in package 'ggplot2' does not exist and so has been treated as a topic
    geom_textbox                            html  
    ggtext                                  html  
*** copying figures
** building package indices
** testing if installed package can be loaded from temporary location
** testing if installed package can be loaded from final location
** testing if installed package keeps a record of temporary installation path
* DONE (ggtext)
codecov-io commented 4 years ago

Codecov Report

Merging #20 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #20   +/-   ##
=======================================
  Coverage   43.47%   43.47%           
=======================================
  Files           5        5           
  Lines         253      253           
=======================================
  Hits          110      110           
  Misses        143      143
Impacted Files Coverage Δ
R/element-textbox.R 0% <ø> (ø) :arrow_up:
R/geom-richtext.R 0% <ø> (ø) :arrow_up:
R/element-markdown.R 96.7% <ø> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3b25fca...1c4fd30. Read the comment docs.

clauswilke commented 4 years ago

Looks good, thanks!