TEhelp: Get help for the TEfits package

View source: R/TEhelp.R

TEhelpR Documentation

Get help for the TEfits package

Description

Many options for fitting using TEfits are specified in a variety of places. To help, this function provides verbose explanations of how to use various tools. Topics will be gradually added, with no guarantee that a given topic has an entry yet.

Usage

TEhelp(topic = "package")

Arguments

topic

Help topic.

Examples

## Brief package summary:
TEhelp('package')

## List topics with TEhelp entries:
TEhelp('topics')

## Overview of error functions:
TEhelp('errFun')

## The log-cosh error function:
TEhelp('errFun=logcosh')

## The ex-Gaussian error function, with change in the exponential component:
TEhelp('errFun=exGauss_tau')

## The d prime link function:
TEhelp('linkFun=d_prime')

## The summary method for TEfit models:
TEhelp('summary(TEfit)')


akcochrane/TEfits documentation built on June 12, 2025, 11:10 a.m.