parametersVignette: Builds Section for Parameters Vignette

View source: R/parametersVignette.R

parametersVignetteR Documentation

Builds Section for Parameters Vignette

Description

Function extracts the documentation for a given GGIR argument as provided in the GGIR documentation and builds the structure for the Parameters Vignette. Function not designed for direct use by package user.

Usage

  parametersVignette(params = "sleep")

Arguments

params

Character (default = "sleep"). Name of the parameters object to build its corresponding section in the Parameters vignette.

Value

Structure for the vignette subsection.

Author(s)

Jairo Hidalgo Migueles <jairo.hidalgo.migueles@gmail.com>


GGIR documentation built on Oct. 17, 2023, 1:12 a.m.