File: read.yaml_section.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (24 lines) | stat: -rw-r--r-- 778 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/options.R
\name{read.yaml_section}
\alias{read.yaml_section}
\title{Reads YAML Options Embbeded into a File}
\usage{
read.yaml_section(section, file = "~/.Rprofile", text = NULL)
}
\arguments{
\item{section}{section name to lookup in the file.
In the file this defined by paired tags \code{"#<section_name>", "#</section_name>"},
or a single tag \code{"#<section_name@file_path>"} that redirect to a YAML file.}

\item{file}{path to the file to parse. Default is to parse the user's \emph{.Rprofile}.}

\item{text}{text to parse.
If provided, then argument \code{file} is not used.}
}
\value{
Returns a list representation of the YAML header
}
\description{
Reads YAML Options Embbeded into a File
}