View source: R/install_cran_with_readme.R
install_cran_with_readme | R Documentation |
The bulk of the code is based on remotes::install_cran()
, for packages without vignette, convert README.md
to vignette and install.
install_cran_with_readme(
pkgs,
repos = getOption("repos"),
type = getOption("pkgType"),
dependencies = NA,
upgrade = c("default", "ask", "always", "never"),
force = FALSE,
quiet = FALSE,
build = TRUE,
build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"),
build_manual = FALSE,
readme_to_vignette = TRUE,
build_vignettes = readme_to_vignette,
...
)
pkgs |
A character vector of packages to install. |
repos |
A character vector giving repositories to use. |
type |
Type of package to |
dependencies |
Which dependencies do you want to check? Can be a character vector (selecting from "Depends", "Imports", "LinkingTo", "Suggests", or "Enhances"), or a logical vector.
The value "soft" means the same as You can also specify dependencies from one or more additional fields, common ones include:
|
upgrade |
Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"
respects the value of the |
force |
Force installation, even if the remote state has not changed since the previous install. |
quiet |
If |
build |
If |
build_opts |
Options to pass to |
build_manual |
If |
readme_to_vignette |
Logical value. If TRUE, installs the contents of |
build_vignettes |
If |
... |
Other arguments passed on to |
The code is basically based on remotes::install_cran()
, that remotes
version 2.4.2.
It just intersperses the process of making README.md
into vignettes if there are no vignettes when the package source is extracted during the installation.
The remotes
package on which this code is based was created by the author of remotes
and is now released at MIT.
The author of the remotes package is currently listed as Developed by Gábor Csárdi, Jim Hester, Hadley Wickham, Winston Chang, Martin Morgan, Dan Tenenbaum, Posit Software, PBC.
See r-lib/remote for detailed authorship.
Invisible NULL
.
Binary format is not supported. The package must be installed from the source package.
Under the current specification, the images in the README.md
are copied for the figures in the directories under man/figures/
, but not for the images in other directories, which are missing.
remotes::install_cran()
https://github.com/r-lib/remotes
Other package installation:
install_github_with_readme()
## Not run:
install_cran_with_readme("arabic2kansuji")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.