File: get_sys_details.Rd

package info (click to toggle)
r-cran-benchmarkme 1.0.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 404 kB
  • sloc: sh: 13; makefile: 2
file content (68 lines) | stat: -rw-r--r-- 1,650 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get_sys_details.R
\name{get_sys_details}
\alias{get_sys_details}
\title{General system information}
\usage{
get_sys_details(
  sys_info = TRUE,
  platform_info = TRUE,
  r_version = TRUE,
  ram = TRUE,
  cpu = TRUE,
  byte_compiler = TRUE,
  linear_algebra = TRUE,
  locale = TRUE,
  installed_packages = TRUE,
  machine = TRUE
)
}
\arguments{
\item{sys_info}{Default \code{TRUE}.}

\item{platform_info}{Default \code{TRUE}.}

\item{r_version}{Default \code{TRUE}.}

\item{ram}{Default \code{TRUE}.}

\item{cpu}{Default \code{TRUE}.}

\item{byte_compiler}{Default \code{TRUE}.}

\item{linear_algebra}{Default \code{TRUE}.}

\item{locale}{Default \code{TRUE}}

\item{installed_packages}{Default \code{TRUE}.}

\item{machine}{Default \code{TRUE}}
}
\value{
A list
}
\description{
The \code{get_sys_info} returns general system level information as a list. The
function parameters control the information to upload. If a parameter is set to
\code{FALSE}, an \code{NA} is uploaded instead. Each element of the list
is contains the output from:
\itemize{
\item \code{Sys.info()};
\item \code{get_platform_info()};
\item \code{get_r_version()};
\item \code{get_ram()};
\item \code{get_cpu()};
\item \code{get_byte_compiler()};
\item \code{get_linear_algebra()};
\item \code{Sys.getlocale()}
\item \code{installed.packages()};
\item \code{.Machine}
\item The package version number;
\item Unique ID - used to extract results;
\item The current date.
}
}
\examples{
## Returns all details about your machine
get_sys_details(cpu = FALSE, installed_packages = FALSE, ram = FALSE)
}