pkgpurl-package: pkgpurl: Facilitate Authoring R Packages in the R Markdown...
In salim-b/pkgpurl: Facilitate Authoring R Packages in the R Markdown File Format
pkgpurl-package R Documentation
pkgpurl: Facilitate Authoring R Packages in the R Markdown File Format
Description
pkgpurl facilitates R package authoring using a literate programming approach. The main idea behind this is to write all of the R source code in R Markdown files ('Rmd/*.Rmd'), which allows the actual code to be freely mixed with explanatory and supplementary information in expressive Markdown format. The main object of pkgpurl is to provide a standardized way to compile the bare '.R' files from the prose-enhanced and thus more human-oriented '.Rmd' files.
Package configuration
Some of pkgpurl's functionality is controlled via package-specific global configuration which can either be set via R options or environment variables (the former take precedence). This configuration includes:
Description R option Environment variable Default value
Whether or not to add a copyright notice at the beginning of the generated .R files as recommended by e.g. the GNU licenses. The notice consists of the name and description of the program and the word Copyright (C) followed by the release years and the name(s) of the copyright holder(s), or if not specified, the author(s). The year is always the current year. All the other information is extracted from the package's DESCRIPTION file. pkgpurl.add_copyright_notice R_PKGPURL_ADD_COPYRIGHT_NOTICE TRUE
Whether or not to add a license notice at the beginning of the generated .R files as recommended by e.g. the GNU licenses. The license is determined from the package's DESCRIPTION file and currently only the AGPL-3.0-or-later license is supported. pkgpurl.add_license_notice R_PKGPURL_ADD_LICENSE_NOTICE TRUE
Whether or not to overwrite pkgdown's reference index in the configuration file _pkgdown.yml with an auto-generated one based on the main input file as described in gen_pkgdown_ref(). pkgpurl.gen_pkgdown_ref R_PKGPURL_GEN_PKGDOWN_REF TRUE
Author(s)
Maintainer: Salim Brüggemann salim@rpkg.dev (ORCID)
See Also
Useful links:
salim-b/pkgpurl documentation built on June 2, 2025, 8:26 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| pkgpurl-package | R Documentation |
pkgpurl: Facilitate Authoring R Packages in the R Markdown File Format
Description
pkgpurl facilitates R package authoring using a literate programming approach. The main idea behind this is to write all of the R source code in R Markdown files ('Rmd/*.Rmd'), which allows the actual code to be freely mixed with explanatory and supplementary information in expressive Markdown format. The main object of pkgpurl is to provide a standardized way to compile the bare '.R' files from the prose-enhanced and thus more human-oriented '.Rmd' files.
Package configuration
Some of pkgpurl's functionality is controlled via package-specific global configuration which can either be set via R options or environment variables (the former take precedence). This configuration includes:
| Description | R option | Environment variable | Default value |
Whether or not to add a copyright notice at the beginning of the generated .R files as recommended by e.g. the GNU licenses. The notice consists of the name and description of the program and the word Copyright (C) followed by the release years and the name(s) of the copyright holder(s), or if not specified, the author(s). The year is always the current year. All the other information is extracted from the package's DESCRIPTION file. | pkgpurl.add_copyright_notice | R_PKGPURL_ADD_COPYRIGHT_NOTICE | TRUE |
Whether or not to add a license notice at the beginning of the generated .R files as recommended by e.g. the GNU licenses. The license is determined from the package's DESCRIPTION file and currently only the AGPL-3.0-or-later license is supported. | pkgpurl.add_license_notice | R_PKGPURL_ADD_LICENSE_NOTICE | TRUE |
Whether or not to overwrite pkgdown's reference index in the configuration file _pkgdown.yml with an auto-generated one based on the main input file as described in gen_pkgdown_ref(). | pkgpurl.gen_pkgdown_ref | R_PKGPURL_GEN_PKGDOWN_REF | TRUE |
Author(s)
Maintainer: Salim Brüggemann salim@rpkg.dev (ORCID)
See Also
Useful links:
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.