cmd

func CheckIfBasePackage ¶

func CheckIfBasePackage(name string) bool

CheckIfBasePackage checks whether the package should be treated as a base R package (included in every R installation) or if it should be treated as a dependency to be downloaded from a package repository.

func CheckIfSkipDependency ¶

func CheckIfSkipDependency(indentation string, packageName string, dependencyName string,
	versionOperator string, versionValue string, outputList *[]PackageDescription) bool

CheckIfSkipDependency checks if processing of the package (dependency) should be skipped. Dependency should be skipped if it is a base R package, or has already been added to output package list (later used to generate the renv.lock).

func CheckIfVersionSufficient ¶

func CheckIfVersionSufficient(availableVersionValue string, versionOperator string,
	requiredVersionValue string) bool

CheckIfVersionSufficient checks if availableVersionValue fulfills the requirement expressed by versionOperator ('>=' or '>') and requiredVersionValue.

func CleanDescriptionOrPackagesEntry ¶

func CleanDescriptionOrPackagesEntry(description string, isDescription bool) string

CleanDescriptionOrPackagesEntry processes a multiline string representing information about one package from PACKAGES file (if isDescription is false), or the whole contents of DESCRIPTION file (if isDescription is true). Removes newlines occurring within filtered fields (which are predominantly fields containing lists of package dependencies). Also removes fields which are not required for further processing.

func DownloadPackagesFiles ¶

func DownloadPackagesFiles(repositoryList []string,
	downloadFileFunction func(string, map[string]string) (int, int64, string)) map[string]string

DownloadPackagesFiles downloads PACKAGES files from repository URLs specified in the repositoryList. Returns a map from repository URL to the string with the contents of PACKAGES file for that repository.

func DownloadTextFile ¶

func DownloadTextFile(url string, parameters map[string]string) (int, int64, string)

DownloadTextFile returns HTTP status code for downloaded file, number of bytes in downloaded content, and the downloaded content itself as a string.

func Execute ¶

func Execute()

func GetGitHubSha ¶

func GetGitHubSha(remoteUsername string, remoteRepo string, remoteRef string, token map[string]string,
	downloadFileFunction func(string, map[string]string) (int, int64, string)) string

GetGitHubSha retrieves SHA of the remoteRef from the remoteUsername/remoteRepo GitHub repository.

func GetGitLabProjectAndSha ¶

func GetGitLabProjectAndSha(projectURL string, remoteRef string, token map[string]string,
	downloadFileFunction func(string, map[string]string) (int, int64, string)) (string, string, string)

GetGitLabProjectAndSha retrieves information about GitLab repository (project path, repository name and commit SHA) from projectURL GitLab API endpoint.

func GetRepositoryKeyByValue ¶

func GetRepositoryKeyByValue(repositoryURL string, repositoryMap map[string]string) string

GetRepositoryKeyByValue searches for repository URL in repositoryMap and returns the name (alias) of that repository which will then be used in output renv.lock file.

func ParseInput ¶

func ParseInput() ([]string, []string, map[string]string, []string)

ParseInput parses CLI input parameters, and returns: list of package DESCRIPTION URLs, list of package repository URLs (in descending priority order), a map from package repository alias (name) to the package repository URL, and a list of allowed types of missing dependencies.

func ParsePackagesFiles ¶

func ParsePackagesFiles(repositoryPackageFiles map[string]string) map[string]PackagesFile

ParsePackagesFiles iterates through package repository PACKAGES files.

func ProcessDependencyFields ¶

func ProcessDependencyFields(packageMap map[string]string,
	packageDependencies *[]Dependency)

ProcessDependencyFields processes a map containing a YAML-like object representing dependencies of a package. Returns a list of Dependency structures corresponding to dependency name, and version constraints.

func ProcessDescription ¶

func ProcessDescription(description DescriptionFile, allPackages *[]PackageDescription)

ProcessDescription reads a string containing DESCRIPTION file and returns a structure with those fields/properties that are required for further processing.

func ProcessDescriptionURL ¶

func ProcessDescriptionURL(descriptionURL string,
	downloadFileFunction func(string, map[string]string) (int, int64, string),
) (map[string]string, string, string, string, string, string, string, string, string)

ProcessDescriptionURL gets information about the git repository in which the package is stored based on the provided descriptionURL to the package DESCRIPTION file.

func ResolveDependenciesRecursively ¶

func ResolveDependenciesRecursively(outputList *[]PackageDescription, name string, versionOperator string,
	versionValue string, dependencyType string, allowedMissingDependencyTypes []string,
	repositoryList []string, packagesFiles map[string]PackagesFile, recursionLevel int,
	fatalErrors *string, nonFatalErrors *string)

ResolveDependenciesRecursively checks dependencies of the package, and their required versions. Checks if the required version is already included in the output package list (later used to generate the renv.lock), or if the dependency should be downloaded from a package repository. Repeats the process recursively for all dependencies not yet processed.