desc: Manipulate DESCRIPTION Files
Version 1.1.0

Tools to read, write, create, and manipulate DESCRIPTION files. It is intended for packages that create or manipulate other packages.

Browse man pages Browse package API and functions Browse package files

AuthorGábor Csárdi [aut, cre], Kirill Müller [aut]
Date of publication2017-01-27 10:17:54
MaintainerGábor Csárdi <csardi.gabor@gmail.com>
LicenseMIT + file LICENSE
Version1.1.0
URL https://github.com/r-pkgs/desc
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("desc")

Man pages

check_encoding: Check encoding of new or existing fields
check_field: Syntactical check of a DESCRIPTION field
cran_ascii_fields: The DESCRIPTION fields that are supposed to be in plain ASCII...
cran_valid_fields: A list of DESCRIPTION fields that are valid according to the...
dep_types: DESCRIPTION fields that denote package dependencies
desc: Read a DESCRIPTION file
desc_add_author: Add an author to Authors@R in DESCRIPTION
desc_add_me: Add the current user as an author to DESCRIPTION
desc_add_remotes: Add locations in the Remotes field in DESCRIPTION
desc_add_role: Add a role to one or more authors in Authors@R, in...
desc_add_to_collate: Add one or more files to the Collate field, in DESCRIPTION
desc_add_urls: Add URLs to the URL field in DESCRIPTION
desc_bump_version: Increase the version number in DESCRIPTION
desc_change_maintainer: Change maintainer of the package, in DESCRIPTION
desc_clear_remotes: Remove all locations from the Remotes field of DESCRIPTION
desc_clear_urls: Remove all URLs from the URL field of DESCRIPTION
desc_del: Remove fields from a DESCRIPTION file
desc_del_author: Remove one or more authors from DESCRIPTION.
desc_del_collate: Delete the Collate field from DESCRIPTION
desc_del_dep: Remove a package dependency from DESCRIPTION
desc_del_deps: Remove all dependencies from DESCRIPTION
desc_del_from_collate: Remove files from the Collate field.
desc_del_remotes: Delete locations from the Remotes field in DESCRIPTION
desc_del_role: Delete a role of an author, in DESCRIPTION
desc_del_urls: Delete URLs from the URL field in DESCRIPTION
desc_fields: List all fields in a DESCRIPTION file
desc_get: Get a field from a DESCRIPTION file
desc_get_author: Query authors by role in Authors@R, in DESCRIPTION
desc_get_authors: Query all authors in Authors@R, in DESCRIPTION
desc_get_collate: Query the Collate field in DESCRIPTION
desc_get_deps: List all package dependencies from a DESCRIPTION file
desc_get_maintainer: Query the package maintainer in DESCRIPTION
desc_get_or_fail: Get fields from a DESCRIPTION file, fail if not found
desc_get_remotes: List the locations in the Remotes field in DESCRIPTION
desc_get_urls: Query the URL field in DESCRIPTION
desc_get_version: Query the package version in DESCRIPTION
desc_has_dep: Check for a dependency
desc_has_fields: Check if some fields are present in a DESCRIPTION file
desc_normalize: Normalize a DESCRIPTION file
desc_print: Print the contents of a DESCRIPTION file to the screen
desc_reformat_fields: Reformat fields in a DESCRIPTION file
desc_reorder_fields: Reorder fields in a DESCRIPTION file
description: Read, write, update, validate DESCRIPTION files
desc_set: Set one or more fields in a DESCRIPTION file
desc_set_authors: Set authors in Authors@R, in DESCRIPTION
desc_set_collate: Set the Collate field in DESCRIPTION
desc_set_dep: Add a package dependency to a DESCRIPTION file
desc_set_deps: Set all package dependencies in DESCRIPTION
desc_set_remotes: Set the Remotes field in DESCRIPTION
desc_set_urls: Set the URL field in DESCRIPTION
desc_set_version: Set the package version in DESCRIPTION
desc_to_latex: Converts a DESCRIPTION file to LaTeX
desc_validate: Validate a DESCRIPTION file

Functions

all_true Source code
as_string Source code
check_author_args Source code
check_encoding Man page Source code
check_field Man page Source code
check_field.DescriptionAddedByRCMD Source code
check_field.DescriptionAuthorsAtR Source code
check_field.DescriptionClassification Source code
check_field.DescriptionCollate Source code
check_field.DescriptionCompression Source code
check_field.DescriptionDate Source code
check_field.DescriptionDependencyList Source code
check_field.DescriptionDescription Source code
check_field.DescriptionEncoding Source code
check_field.DescriptionField Source code
check_field.DescriptionFreeForm Source code
check_field.DescriptionLanguage Source code
check_field.DescriptionLicense Source code
check_field.DescriptionLogical Source code
check_field.DescriptionMaintainer Source code
check_field.DescriptionOSType Source code
check_field.DescriptionPackage Source code
check_field.DescriptionPackageList Source code
check_field.DescriptionPriority Source code
check_field.DescriptionRepoList Source code
check_field.DescriptionRepository Source code
check_field.DescriptionTitle Source code
check_field.DescriptionType Source code
check_field.DescriptionURL Source code
check_field.DescriptionURLList Source code
check_field.DescriptionVersion Source code
check_for_package Source code
chk Source code
chks Source code
color_bad Source code
cran_ascii_fields Man page
cran_valid_fields Man page
create_field Source code
create_fields Source code
dep_types Man page
deparse_authors_at_r Source code
deparse_collate Source code
deparse_deps Source code
deparse_remotes Source code
deparse_urls Source code
desc Man page Source code
desc_add_author Man page
desc_add_me Man page
desc_add_remotes Man page
desc_add_role Man page
desc_add_to_collate Man page
desc_add_urls Man page
desc_bump_version Man page
desc_change_maintainer Man page
desc_clear_remotes Man page
desc_clear_urls Man page
desc_del Man page
desc_del_author Man page
desc_del_collate Man page
desc_del_dep Man page
desc_del_deps Man page
desc_del_from_collate Man page
desc_del_remotes Man page
desc_del_role Man page
desc_del_urls Man page
desc_fields Man page
desc_get Man page
desc_get_author Man page
desc_get_authors Man page
desc_get_collate Man page
desc_get_deps Man page
desc_get_maintainer Man page
desc_get_or_fail Man page
desc_get_remotes Man page
desc_get_urls Man page
desc_get_version Man page
desc_has_dep Man page
desc_has_fields Man page
desc_normalize Man page
desc_print Man page
desc_reformat_fields Man page
desc_reorder_fields Man page
desc_set Man page
desc_set_authors Man page
desc_set_collate Man page
desc_set_dep Man page
desc_set_deps Man page
desc_set_remotes Man page
desc_set_urls Man page
desc_set_version Man page
desc_to_latex Man page
desc_validate Man page
description Man page
ensure_authors_at_r Source code
field_order Source code
find_description Source code
find_field_class Source code
flatten Source code
format.DescriptionAuthorsAtR Source code
format.DescriptionCollate Source code
format.DescriptionDependencyList Source code
format.DescriptionField Source code
format_url Source code
generate_api Source code
get_description_from_package Source code
get_version_components Source code
has_no_na Source code
idesc_add_author Source code
idesc_add_me Source code
idesc_add_remotes Source code
idesc_add_role Source code
idesc_add_to_collate Source code
idesc_add_urls Source code
idesc_as_matrix Source code
idesc_bump_version Source code
idesc_change_maintainer Source code
idesc_clear_remotes Source code
idesc_clear_urls Source code
idesc_create Source code
idesc_create_cmd Source code
idesc_create_file Source code
idesc_create_package Source code
idesc_create_text Source code
idesc_del Source code
idesc_del_author Source code
idesc_del_collate Source code
idesc_del_dep Source code
idesc_del_deps Source code
idesc_del_from_collate Source code
idesc_del_remotes Source code
idesc_del_role Source code
idesc_del_urls Source code
idesc_fields Source code
idesc_get Source code
idesc_get_author Source code
idesc_get_authors Source code
idesc_get_collate Source code
idesc_get_deps Source code
idesc_get_maintainer Source code
idesc_get_or_fail Source code
idesc_get_remotes Source code
idesc_get_urls Source code
idesc_get_version Source code
idesc_has_dep Source code
idesc_has_fields Source code
idesc_normalize Source code
idesc_print Source code
idesc_really_set_collate Source code
idesc_reformat_fields Source code
idesc_reorder_fields Source code
idesc_set Source code
idesc_set_authors Source code
idesc_set_collate Source code
idesc_set_dep Source code
idesc_set_deps Source code
idesc_set_remotes Source code
idesc_set_urls Source code
idesc_set_version Source code
idesc_str Source code
idesc_to_latex Source code
idesc_validate Source code
idesc_write Source code
is_ascii Source code
is_authors Source code
is_collate_field Source code
is_collate_field_or_all Source code
is_collate_field_or_all_or_default Source code
is_constructor_cmd Source code
is_count Source code
is_deps_df Source code
is_dir Source code
is_existing_file Source code
is_flag Source code
is_gz_file Source code
is_package_archive Source code
is_package_version Source code
is_path Source code
is_string Source code
is_string_or_null Source code
is_tar_gz_file Source code
is_url Source code
is_url_list Source code
is_valid_package_file_name Source code
is_version_component Source code
is_zip_file Source code
ngrepl Source code
parse_authors_at_r Source code
parse_collate Source code
parse_deps Source code
parse_remotes Source code
parse_url_list Source code
parse_urls Source code
postprocess_trailing_ws Source code
read_dcf Source code
real_add_to_collate Source code
real_del_from_collate Source code
same_deps Source code
search_for_author Source code
set_author_field Source code
str_trim Source code
toLatex.DescriptionAuthorsAtR Source code
toLatex.DescriptionCollate Source code
toLatex.DescriptionField Source code
toLatex.DescriptionURL Source code
toLatex.DescriptionURLList Source code
toLatex.character Source code
toLatex.person Source code
which_collate Source code

Files

inst
inst/README.Rmd
inst/NEWS.md
inst/README.md
inst/DESCRIPTION
inst/DESCRIPTION2
tests
tests/testthat.R
tests/testthat
tests/testthat/test-encoding.R
tests/testthat/test-utils.R
tests/testthat/test-desc.R
tests/testthat/fixtures
tests/testthat/fixtures/notpkg_1.0.tar.gz
tests/testthat/fixtures/pkg_1.0.0.tgz
tests/testthat/fixtures/xxx.tar.gz
tests/testthat/fixtures/pkg_1.0.0.tar.gz
tests/testthat/fixtures/pkg_1.0.0_R_x86_64-pc-linux-gnu.tar.gz
tests/testthat/fixtures/xxx.zip
tests/testthat/fixtures/xxx.gz
tests/testthat/test-idempotent.R
tests/testthat/test-repair.R
tests/testthat/D1
tests/testthat/test-urls.R
tests/testthat/test-to_latex.R
tests/testthat/test-collate.R
tests/testthat/D2
tests/testthat/test-checks.R
tests/testthat/test-write.R
tests/testthat/test-create.R
tests/testthat/test-validation.R
tests/testthat/test-non-oo.R
tests/testthat/test-deps.R
tests/testthat/D3
tests/testthat/output
tests/testthat/output/to_latex.tex
tests/testthat/test-trailing-ws.R
tests/testthat/test-authors.R
tests/testthat/files
tests/testthat/files/DESCRIPTION
tests/testthat/test-queries.R
tests/testthat/test-remotes.R
tests/testthat/test-versions.R
tests/testthat/helper.R
tests/testthat/D4
tests/testthat/test-archives.R
tests/testthat/test-read.R
tests/testthat/test-str.R
NAMESPACE
NEWS.md
R
R/classes.R
R/utils.R
R/version.R
R/remotes.R
R/deps.R
R/collate.R
R/encoding.R
R/assertions.R
R/authors-at-r.R
R/description.R
R/latex.R
R/str.R
R/syntax_checks.R
R/urls.R
R/constants.R
R/read.R
R/validate.R
R/non-oo-api.R
R/package-archives.R
MD5
DESCRIPTION
man
man/desc_add_author.Rd
man/desc_get.Rd
man/desc_del_dep.Rd
man/dep_types.Rd
man/description.Rd
man/desc_get_maintainer.Rd
man/check_field.Rd
man/desc_reformat_fields.Rd
man/desc_add_role.Rd
man/desc_has_dep.Rd
man/desc_get_deps.Rd
man/desc_get_author.Rd
man/desc_del_deps.Rd
man/desc_del_from_collate.Rd
man/desc_get_urls.Rd
man/desc_reorder_fields.Rd
man/desc_set_authors.Rd
man/desc_has_fields.Rd
man/desc.Rd
man/desc_get_authors.Rd
man/desc_set_version.Rd
man/desc_add_to_collate.Rd
man/desc_get_collate.Rd
man/desc_set.Rd
man/desc_clear_remotes.Rd
man/desc_del_urls.Rd
man/desc_set_dep.Rd
man/desc_normalize.Rd
man/desc_get_version.Rd
man/desc_del_remotes.Rd
man/desc_change_maintainer.Rd
man/cran_valid_fields.Rd
man/desc_clear_urls.Rd
man/desc_fields.Rd
man/desc_add_remotes.Rd
man/desc_to_latex.Rd
man/desc_del_collate.Rd
man/desc_add_urls.Rd
man/desc_print.Rd
man/desc_get_remotes.Rd
man/desc_set_deps.Rd
man/desc_set_urls.Rd
man/desc_bump_version.Rd
man/desc_del.Rd
man/desc_add_me.Rd
man/desc_set_remotes.Rd
man/desc_del_author.Rd
man/cran_ascii_fields.Rd
man/desc_validate.Rd
man/desc_del_role.Rd
man/desc_set_collate.Rd
man/check_encoding.Rd
man/desc_get_or_fail.Rd
LICENSE
desc documentation built on May 19, 2017, 1:19 p.m.