Comments (10)
hi @maelle ! I really like this post! I was wondering if you know of any way to make files of the type .Rmd.orig
look and act like "real" .Rmd
files during development?
from blog.
Thank you so much MaΓ«lle, I could't find how to limit the computation time in my vignettes!
from blog.
Hello and thank you for the great article, I am building vignettes for my package. After looking around the internet and your blogpost, I am still confused about the differences and relationship between vignettes/
, inst/doc/
and doc/
. When I run build_vignettes()
, I get an .R
file and a .html
file in the vignettes/
folder and the doc/
folder moves outside of inst/
and remains empty. Additionally I get the following message when running build_vignettes()
:
Error in if (dir_exists(path %||% "") && is_in_proj(path)) { :
missing value where TRUE/FALSE needed
Though I have no idea where it is coming from (Upon some more search, the error seems to come from the use_this
package, see link to source code) All help is appreciated
from blog.
π @lc5415 Why do you run build_vignettes()
by the way?
from blog.
I am asking because I never run it and https://r-pkgs.org/vignettes.html#vignette-workflow-2 also recommends building the whole package instead.
from blog.
Hello @maelle thanks, for your message. I guess I run build vignettes to isolate the process and check whether my vignettes could be built on their own. Thanks for pointing me to the book, I was struggling to find the right resources regarding vignettes. The trouble I pointed at in the previous comment seemed to disappear, on its own though. If devtools::install_github()
does not build vignettes by default, what is the best way to distribute vignettes, pkgdown
? Otherwise, do CRAN packages installed through install.packages()
have their vignettes built?
from blog.
RStudio Community thread https://community.rstudio.com/t/difference-between-inst-doc-and-doc/83836/3
from blog.
No, that'd be nice indeed. Wouldn't this be a good feature request for the RStudio IDE ( no idea how this would work with other editors)? If you open one please tag me and I'll go π it π
from blog.
It was suggested (thanks @jeroen) that instead, one should tweak the workflow to call the original vignette .Rmd but in another path. This way it's actually an Rmd.
from blog.
it'd probably be wise to have their filenames start with an underscore cf https://pkgdown.r-lib.org/reference/build_articles.html so that pkgdown will ignore them
from blog.
Related Issues (20)
- testthat utility belts HOT 9
- Everything centered on small screens, e.g. mobile HOT 1
- cran etiquette HOT 1
- Helper code and files for your testthat tests - R-hub blog HOT 9
- What is OAuth2.0 HOT 2
- backports and other approaches HOT 6
- the story of roxygen2? HOT 2
- onLoad(), package internal environment etc. HOT 2
- How to use r-hub docker containers in GitHub actions HOT 5
- Caching the results of functions of your R package - R-hub blog HOT 2
- Tools for input checking in functions HOT 7
- Post about ellipsis HOT 3
- How to deal with OAuth2.0 in R packages? - R-hub blog HOT 3
- Checking the inputs of your R functions - R-hub blog HOT 1
- No line break between code and code output HOT 1
- Minimum R version dependency in R packages - R-hub blog HOT 4
- Objects that feel mutable in R - R-hub blog HOT 3
- A testing pattern: adding switches to your code - R-hub blog HOT 1
- Overview of the CRAN checks API - R-hub blog HOT 4
- Cliff notes about the cli package - R-hub blog HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from blog.