cmd

package
v1.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2025 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Overview

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 F. Hoffmann-La Roche AG

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source
const GitHub = "GitHub"
View Source
const GitLab = "GitLab"
View Source
const HTMLLinkEnd = "</a>"
View Source
const HTMLReportTemplate = `` /* 10632-byte string literal not displayed */
View Source
const HTMLStatusOK = "<span class=\"badge bg-success\">OK</span>"
View Source
const InstallResultInfoStatusBuildFailed = "BUILD_FAILED"
View Source
const InstallResultInfoStatusFailed = "FAILED"
View Source
const InstallResultInfoStatusSucceeded = "SUCCEEDED"

Variables

This section is empty.

Functions

func Execute

func Execute()

Types

type BioC

type BioC struct {
	Version string
}

type BuildPackageChanInfo added in v0.2.7

type BuildPackageChanInfo struct {
	BuildStatus    string
	OutputLocation string
	Err            error
}

type CacheInfo

type CacheInfo struct {
	Path   string
	Length int64
}

Struct used to store data about tar.gz packages saved in local cache.

type DownloadInfo

type DownloadInfo struct {
	// if statusCode > 0 it is identical to HTTP status code from download, or 200 in case of successful
	// git repository clone
	// message field contains URL of the package
	// statusCode == -1 means that package version could not be found in any BioConductor repository
	// message field contains error message
	// statusCode == -2 means that there was an error during cloning of GitHub repository
	// message field contains error message
	// statusCode == -3 means that there was an error during cloning of GitLab repository
	// message field contains error message
	// statusCode == -4 means that a network error occurred during HTTP download
	// message field contains URL of the package
	StatusCode    int    `json:"statusCode"`
	Message       string `json:"message"`
	ContentLength int64  `json:"contentLength"`
	// file where the package is stored, or directory where git repository has been cloned
	// empty in case of errors
	OutputLocation string `json:"outputLocation"`
	// number of bytes saved thanks to caching (size of cached package file)
	SavedBandwidth int64 `json:"savedBandwidth"`
	// possible values: tar.gz, git, bioconductor,
	// tgz in case of binary macOS packages,
	// zip in case of binary Windows packages,
	// or empty value in case of error
	DownloadedPackageType string `json:"downloadedPackageType"`
	PackageName           string `json:"packageName"`
	PackageVersion        string `json:"packageVersion"`
	// Contains git SHA of cloned package, or exceptionally git tag or branch, if SHA was not provided in renv.lock.
	GitPackageShaOrRef string `json:"gitPackageShaOrRef"`
	// Name of R package repository ("Repository" renv.lock field, e.g. CRAN, RSPM) in case package
	// source ("Source" renv.lock field) is "Repository".
	// Otherwise, "GitHub" or "GitLab" depending on "Source" renv.lock field.
	// Empty in case of errors.
	PackageRepository string `json:"packageRepository"`
}

type DownloadedPackage added in v1.0.0

type DownloadedPackage struct {
	PackageType       string
	PackageVersion    string
	PackageRepository string
	Location          string
}

type ExecRCmdInstallChanInfo added in v0.2.7

type ExecRCmdInstallChanInfo struct {
	Output string
	Err    error
}

type InstallResultInfo

type InstallResultInfo struct {
	PackageName      string `json:"packageName"`
	InputLocation    string `json:"inputLocation"`
	PackageType      string `json:"packageType"`
	PackageVersion   string `json:"packageVersion"`
	Status           string `json:"status"`
	LogFilePath      string `json:"logFilePath"`
	BuildStatus      string `json:"buildStatus"`
	BuildLogFilePath string `json:"buildLogFilePath"`
}

type ItemCheckInfo

type ItemCheckInfo struct {
	CheckItemType    string // NOTE, WARNING or ERROR
	CheckItemContent string // content of NOTE, WARNING or ERROR
}

type PackageCheckInfo

type PackageCheckInfo struct {
	PackagePath         string // path to directory where the package has been installed
	PackageName         string
	LogFilePath         string // path to the file containing log of R CMD check for the package
	MostSevereCheckItem string // OK, NOTE, WARNING or ERROR
	Info                []ItemCheckInfo
	CheckTime           int
	ShouldFail          bool // Whether a NOTE or WARNING occurred that would cause the check to fail.
}

type PackageInfo

type PackageInfo struct {
	Version  string
	Checksum string
}

type PackagesData

type PackagesData struct {
	PackageName        string `json:"packageName"`
	PackageVersion     string `json:"packageVersion"`
	GitPackageShaOrRef string `json:"gitPackageShaOrRef"`
	DownloadStatusText string `json:"downloadStatusText"`
	InstallStatusText  string `json:"installStatusText"`
	CheckStatusText    string `json:"checkStatusText"`
	BuildStatusText    string `json:"buildStatusText"`
	CheckTime          string `json:"checkTime"`
	PackageRepository  string `json:"packageRepository"`
}

type RenvInfo added in v0.1.1

type RenvInfo struct {
	RenvFilename string `json:"renvFilename"`
	RenvContents string `json:"renvContents"`
}

type Renvlock

type Renvlock struct {
	R            Rversion
	Bioconductor BioC
	Packages     map[string]Rpackage
}

type ReportInfo

type ReportInfo struct {
	PackagesInformation []PackagesData `json:"packagesInformation"`
	SystemInformation   *SystemInfo    `json:"systemInformation"`
	RenvInformation     RenvInfo       `json:"renvInformation"`
	TotalCheckTime      string         `json:"totalCheckTime"`
}

type Rpackage

type Rpackage struct {
	Package      string
	Version      string
	Source       string
	Repository   string
	Hash         string
	RemoteType   string   `json:",omitempty"`
	Requirements []string `json:",omitempty"`
	// Below 'Remote' properties only exist in renv.lock
	// if package comes from git repository.
	RemoteHost     string `json:",omitempty"`
	RemoteRepo     string `json:",omitempty"`
	RemoteUsername string `json:",omitempty"`
	RemoteRef      string `json:",omitempty"`
	RemoteSha      string `json:",omitempty"`
	RemoteSubdir   string `json:",omitempty"`
}

type Rrepository

type Rrepository struct {
	Name string
	URL  string
}

type Rversion

type Rversion struct {
	Version      string
	Repositories []Rrepository
}

type SystemInfo

type SystemInfo struct {
	OperatingSystem string `json:"operatingSystem"`
	Architecture    string `json:"architecture"`
	KernelVersion   string `json:"kernelVersion"`
	PrettyName      string `json:"prettyName"`
	SystemPackages  string `json:"systemPackages"`
	RVersion        string `json:"rVersion"`
	Time            string `json:"time"`
	EnvVariables    string `json:"envVariables"`
	Hostname        string `json:"hostname"`
}

type SystemMetrics added in v1.0.4

type SystemMetrics struct {
	ElapsedTimeSeconds      float64 `csv:"elapsed_time_seconds" json:"elapsed_time_seconds"`
	RProcessesMemory        uint64  `csv:"r_processes_memory" json:"r_processes_memory"`
	ChromiumProcessesMemory uint64  `csv:"chromium_processes_memory" json:"chromium_processes_memory"`
	ScribeMemory            uint64  `csv:"scribe_memory" json:"scribe_memory"`
	OthersMemory            uint64  `csv:"others_memory" json:"others_memory"`
	TotalMemoryUsed         uint64  `csv:"total_memory_used" json:"total_memory_used"`
	SystemMemoryUsed        uint64  `csv:"system_memory_used" json:"system_memory_used"`
	SystemMemoryFree        uint64  `csv:"system_memory_free" json:"system_memory_free"`
	NumberOfGoroutines      int     `csv:"number_of_goroutines" json:"number_of_goroutines"`
	Load1                   float64 `csv:"load_1" json:"load_1"`
	Load5                   float64 `csv:"load_5" json:"load_5"`
	Load15                  float64 `csv:"load_15" json:"load_15"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL