|
|
| Línia 760: |
Línia 760: |
|
| |
|
| La forma más sencilla de hacerlo es crear un nuevo fichero llamado ''nombrefunción.Rd'' (por ejemplo ''intervals.Rd'') y escribir directamente la ayuda. Se aconseja que los ficheros de ayuda contengan siempre los mismos apartados (nombre de la función, parámetros, resultados, etc.), como se puede ver en el [http://acrida.2mydns.com/wikitraba/arxius/source.rar código fuente] del [http://acrida.2mydns.com/wikitraba/arxius/traba_1.4-1.zip paquete Traba]. | | La forma más sencilla de hacerlo es crear un nuevo fichero llamado ''nombrefunción.Rd'' (por ejemplo ''intervals.Rd'') y escribir directamente la ayuda. Se aconseja que los ficheros de ayuda contengan siempre los mismos apartados (nombre de la función, parámetros, resultados, etc.), como se puede ver en el [http://acrida.2mydns.com/wikitraba/arxius/source.rar código fuente] del [http://acrida.2mydns.com/wikitraba/arxius/traba_1.4-1.zip paquete Traba]. |
|
| |
| A continuación se reproduce el contenido del fichero ''intervals.Rd'':
| |
|
| |
| \name{interval}
| |
| \alias{interval}
| |
| %- Also NEED an '\alias' for EACH other topic documented here.
| |
| \title{ Exponenciacion de coeficientes }
| |
| \description{
| |
| Exponencia los coeficientes y obtiene los IC de los siguientes modelos de regresion: lineal, logistica, logbinomial, Poisson y Cox
| |
| }
| |
| \usage{
| |
| interval(model, digits = 2, nivell = 0.95, alfa = F)
| |
| }
| |
| %- maybe also 'usage' for other objects documented here.
| |
| \arguments{
| |
| \item{model}{ un modelo de regresion lineal, logistica, logbinomial, Poisson o Cox }
| |
| \item{digits}{ precisión del cálculo. Por defecto 2 }
| |
| \item{nivell}{ nivel de confianza del IC. Debe especificarse como un número entre 0 y 1. Por defecto 0.95 }
| |
| \item{alfa}{ valor logico que indica si debe mostrarse el IC de la constante (excepto para el modelo de Cox). Por defecto FALSE }
| |
| }
| |
| \details{
| |
| El argumento model es obligatorio, y debe ser un modelo de regresion creado in situ o un objeto guardado anteriormente a partir de un modelo. Si los argumentos digits, nivell y alfa no se suministran, se usarán los valores por defecto
| |
| Los argumentos deben especificarse entre paréntesis después del nombre de la función. Si no se especifica el nombre del argumento, la función los entiende por orden
| |
| }
| |
| \value{
| |
|
| |
| \item{intervalo}{Beta (lineal), OR (logistica), RR (logbinomial), IRR (Poisson) o HR (Cox) para cada covariable del modelo con sus IC}
| |
|
| |
| }
| |
| \references{ }
| |
| \author{ PaKiTo }
| |
| \note{Se admiten todo tipo de comentarios y sugerencias a traves del traba }
| |
|
| |
|
| |
| \keyword{ internal }% at least one, from doc/KEYWORDS
| |
| \keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
| |
|
| |
|
| |
|
| |
|
| === Construcción de paquetes === | | === Construcción de paquetes === |