{ "$schema": "http://json-schema.org/draft-07/schema#", "$comment": "See https://github.com/rstudio/renv", "title": "renv.lock file", "description": "A schema for renv.lock files generated by the R package {renv}", "type": "object", "properties": { "R": { "description": "Version of R used in the project", "type": "object", "properties": { "Version": { "description": "The version of R used", "type": "string", "examples": [ "4.4.3" ] }, "Repositories": { "description": "The R repositories used in this project", "type": "array", "items": { "type": "object", "properties": { "Name": { "description": "Name of the repository", "type": "string", "examples": [ "CRAN" ] }, "URL": { "description": "URL of the repository", "type": "string", "format": "uri", "examples": [ "https://cloud.r-project.org" ] } }, "required": [ "Name", "URL" ] } } }, "required": [ "Version", "Repositories" ] }, "Bioconductor": { "description": "Bioconductor release used in the project", "type": "object", "properties": { "Version": { "description": "Release of Bioconductor", "type": "string", "examples": [ "3.18" ] } }, "required": [ "Version" ] }, "Python": { "description": "Version of Python used in the project", "type": "object", "properties": { "Name": { "description": "Path to the Python environment", "type": "string", "examples": [ ".venv", "./renv/python/virtualenvs/renv-python-3.10" ] }, "Type": { "description": "Type of Python environment", "type": "string", "examples": [ "virtualenv" ] }, "Version": { "description": "Version of Python required", "type": "string", "examples": [ "3.10.12", "3.9.0" ] } }, "required": [ "Name", "Type", "Version" ] }, "Packages": { "description": "Packages required by the R project", "type": "object", "additionalProperties": { "type": "object", "properties": { "Package": { "description": "The package name", "type": "string", "examples": [ "ggplot2", "dplyr" ] }, "Version": { "description": "The package version", "type": "string", "examples": [ "1.0.0", "3.4.6" ] }, "Source": { "description": "The location from which this package was retrieved", "type": "string", "examples": [ "Repository", "GitHub", "Bioconductor", "/mnt/r/pkg/package_name_1.0.1.tar.gz" ] }, "Repository": { "description": "The name of the repository (if any)", "type": "string", "examples": [ "CRAN" ] }, "Hash": { "description": "A unique hash for this package", "type": "string", "pattern": "^[a-fA-F0-9]{32}$", "examples": ["06230136b2d2b9ba5805e1963fa6e890"] }, "biocViews": { "description": "Bioconductor package dependencies", "type": "string" }, "RemoteType": { "description": "Type of remote, typically written for packages installed by the devtools, remotes and pak packages", "type": "string", "examples": [ "standard", "github" ] }, "RemoteHost": { "description": "Host for the remote", "type": "string", "format": "hostname", "examples": ["api.github.com"] }, "RemoteUsername": { "description": "Username for the remote repo", "type": "string" }, "RemoteRepo": { "description": "Repository URL for the remote package", "type": "string", "examples": [ "https://cran.rstudio.com", "https://cloud.r-project.org" ] }, "RemoteRepos": { "description": "Remote repositories URIs", "type": "string", "format": "uri", "examples": [ "https://cran.rstudio.com", "https://cloud.r-project.org" ] }, "RemoteRef": { "description": "Git reference (branch, tag) of remote", "type": "string" }, "RemotePkgRef": { "description": "Package name reference on remote", "type": "string" }, "RemotePkgPlatform": { "description": "Platform of remote binary", "type": "string", "examples": ["aarch64-apple-darwin20"] }, "RemoteSha": { "description": "SHA of remote commit", "type": "string", "examples": ["1763e0dcb72fb58d97bab97bb834fc71f1e012bc"] }, "Title": { "description": "Package title from DESCRIPTION", "type": "string", "examples": [ "Read Rectangular Text Data" ] }, "Authors@R": { "description": "Authors field in DESCRIPTION syntax", "type": "string" }, "Description": { "description": "Long description from DESCRIPTION file", "type": "string" }, "License": { "description": "License declared by the package", "type": "string", "examples": [ "MIT + file LICENSE" ] }, "URL": { "description": "Homepage or URL fields from DESCRIPTION", "type": "string", "examples": [ "https://github.com/tidyverse/readr" ] }, "BugReports": { "description": "URL for reporting bugs/issues", "type": "string", "examples": [ "https://github.com/tidyverse/readr/issues" ] }, "Author": { "description": "Formatted Author field", "type": "string" }, "Maintainer": { "description": "Package maintainer with email", "type": "string", "examples": [ "Jennifer Bryan " ] }, "Depends": { "description": "Package dependencies", "type": "array", "items": { "type": "string" }, "examples": [ [ "R (>= 3.6)", "jsonlite", "lifecycle", "magrittr", "stringi" ] ] }, "Imports": { "description": "Imported packages", "type": "array", "items": { "type": "string" } }, "LinkingTo": { "description": "Packages linked at compile time", "type": "array", "items": { "type": "string" } }, "Suggests": { "description": "Suggested packages", "type": "array", "items": { "type": "string" } }, "Enhances": { "description": "Enhanced packages", "type": "array", "items": { "type": "string" } }, "SystemRequirements": { "description": "System requirements for compilation", "type": "string" }, "VignetteBuilder": { "description": "Builder used for vignettes", "type": "string", "examples": [ "knitr", "rmakrdown" ] }, "Type": { "description": "Type flag from DESCRIPTION", "type": "string", "examples": [ "Package" ] }, "Date": { "description": "Publication date of this version. Generally considered deprecated in DESCRIPTION", "type": "string", "format": "date", "examples": [ "2024-05-06" ] }, "ByteCompile": { "description": "Whether package is byte-compiled", "type": "string", "examples": [ "true" ] }, "Biarch": { "description": "Whether binaries built for multiple architectures", "type": "string", "examples": [ "TRUE" ] }, "Encoding": { "description": "File encoding used by the package", "type": "string", "examples": [ "UTF-8" ] }, "Language": { "description": "Primary language of the package documentation", "type": "string", "examples": [ "en-US" ] }, "RoxygenNote": { "description": "RoxygenNote from DESCRIPTION", "type": "string", "examples": [ "7.3.2" ] }, "NeedsCompilation": { "description": "Flag whether package needs compilation", "type": "string", "examples": [ "yes" ] }, "Copyright": { "description": "Copyright notes from DESCRIPTION", "type": "string" }, "Config/Needs/website": { "description": "Configuration for website dependencies", "type": "string" }, "Config/testthat/edition": { "description": "Which edition of testthat to use", "type": "string" }, "Config/testthat/parallel": { "description": "Whether testthat runs in parallel", "type": "string" }, "Config/testthat/start-first": { "description": "testthat start-first phases", "type": "string" }, "Config/autostyle/scope": { "description": "autostyle configuration scope", "type": "string" }, "Config/autostyle/strict": { "description": "autostyle strictness flag", "type": "string" }, "Config/autostyle/rmd": { "description": "autostyle R Markdown support flag", "type": "string" } }, "required": [ "Package" ] } } }, "required": [ "R", "Packages" ] }