File: mxComputeLoadContext.Rd

package info (click to toggle)
r-cran-openmx 2.21.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,412 kB
  • sloc: cpp: 36,577; ansic: 13,811; fortran: 2,001; sh: 1,440; python: 350; perl: 21; makefile: 5
file content (52 lines) | stat: -rw-r--r-- 1,614 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/MxCompute.R
\name{mxComputeLoadContext}
\alias{mxComputeLoadContext}
\alias{MxComputeLoadContext-class}
\title{Load contextual data to supplement checkpoint}
\usage{
mxComputeLoadContext(
  method = c("csv"),
  path = c(),
  column,
  ...,
  sep = " ",
  verbose = 0L,
  header = TRUE,
  col.names = NULL
)
}
\arguments{
\item{method}{name of the conduit used to load the columns.}

\item{path}{the path to the file containing the data}

\item{column}{a character vector. The column names to log.}

\item{...}{Not used.  Forces remaining arguments to be specified by name.}

\item{sep}{the field separator character. Values on each line of the file are separated by this character.}

\item{verbose}{integer. Level of run-time diagnostic output. Set to zero to disable}

\item{header}{logical. Whether the first row contains column headers.}

\item{col.names}{character vector. Column names}
}
\description{
\lifecycle{experimental}
}
\details{
Currently, this only supports comma separated value format and no
row names. If \code{header=TRUE} and \code{col.names} are
provided, the \code{col.names} take precedence. If
\code{header=FALSE} and no \code{col.names} are provided then
the column names consist of the file name and column offset.

An \code{originalDataIsIndexOne} option is not offered. You'll need to
add an extra line at the start on your file if you wish to make
use of \code{originalDataIsIndexOne} in \code{mxComputeLoad*}.
}
\seealso{
\link{mxComputeCheckpoint}, \link{mxComputeLoadData}, \link{mxComputeLoadMatrix}
}