From 7141d015147effa7fe89e59739b9346a6da67377 Mon Sep 17 00:00:00 2001
From: Eduardo Junior <edujrrib@gmail.com>
Date: Fri, 25 Mar 2016 21:03:31 -0300
Subject: [PATCH] =?UTF-8?q?Padroniza=20documenta=C3=A7=C3=A3o=20e=20amplia?=
 =?UTF-8?q?=20sess=C3=A3o=20examples?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Os títulos dos datasets foram capitalizados, a documentação toda
seguiu o padrão de indentação (4 caracteres da margem) e os examples
foram ampliados incluindo algumas informações de forma gráfica.
---
 R/CharnetEx1.20.R    | 10 +++++-----
 R/CharnetEx1.5.R     | 14 +++++++++-----
 R/CharnetEx1.6.R     | 14 ++++++++++----
 R/CharnetEx2.10.R    | 16 +++++++++-------
 R/CharnetEx2.9.R     | 18 ++++++++++++------
 man/CharnetEx1.20.Rd | 33 +++++++++++++++++++++++++++++++++
 man/CharnetEx1.5.Rd  | 32 ++++++++++++++++++++++++++++++++
 man/CharnetEx1.6.Rd  | 33 +++++++++++++++++++++++++++++++++
 man/CharnetEx2.10.Rd | 35 +++++++++++++++++++++++++++++++++++
 man/CharnetEx2.9.Rd  | 39 +++++++++++++++++++++++++++++++++++++++
 10 files changed, 217 insertions(+), 27 deletions(-)
 create mode 100644 man/CharnetEx1.20.Rd
 create mode 100644 man/CharnetEx1.5.Rd
 create mode 100644 man/CharnetEx1.6.Rd
 create mode 100644 man/CharnetEx2.10.Rd
 create mode 100644 man/CharnetEx2.9.Rd

diff --git a/R/CharnetEx1.20.R b/R/CharnetEx1.20.R
index ed4755f..c966028 100644
--- a/R/CharnetEx1.20.R
+++ b/R/CharnetEx1.20.R
@@ -1,17 +1,17 @@
 #' @name CharnetEx1.20
 #' 
-#' @title Dois testes de avaliação de personalidade
+#' @title Testes de Avaliação de Personalidade
 #' 
 #' @description Dois testes de avaliação de personalidade aplicados a 20
-#'              indivíduos.
+#'     indivíduos.
 #'
 #' @format Um \code{data.frame} com 2 colunas e 20 linhas.
 #'
 #' \describe{
 #'
-#' \item{\code{t1}}{Teste I}
+#' \item{\code{t1}}{Resultados do teste I, em pontos.}
 #'
-#' \item{\code{t2}}{Teste II}
+#' \item{\code{t2}}{Resultados do teste II, em pontos.}
 #'
 #' }
 #'
@@ -28,4 +28,4 @@
 #'
 #' plot(CharnetEx1.20)
 #'
-NULL
\ No newline at end of file
+NULL
diff --git a/R/CharnetEx1.5.R b/R/CharnetEx1.5.R
index 0653946..3aa756a 100644
--- a/R/CharnetEx1.5.R
+++ b/R/CharnetEx1.5.R
@@ -1,8 +1,8 @@
 #' @name CharnetEx1.5
 #' 
-#' @title Tempo de duração do intervalo para o cafézinho
+#' @title Tempo de Duração do Intervalo para o Cafezinho
 #' 
-#' @description Tempo de duração do intervalo para o cafézinho para uma
+#' @description Tempo de duração do intervalo para o cafezinho para uma
 #'     amostra de 20 empregados de uma grande empresa.
 #'
 #' @format Um \code{vetor} numérico com 20 observações.
@@ -18,9 +18,13 @@
 #'
 #' data(CharnetEx1.5)
 #'
-#' mean(CharnetEx1.5)
-#' sd(CharnetEx1.5)
+#' (m <- mean(CharnetEx1.5))
+#' (s <- sd(CharnetEx1.5))
 #' fivenum(CharnetEx1.5)
 #'
-#'
+#' curve(dnorm(x, m, s),
+#'       xlim = extendrange(CharnetEx1.5, f = 0.2),
+#'       col = 4, lwd = 2)
+#' hist(CharnetEx1.5, prob = TRUE, add = TRUE)
+#' rug(CharnetEx1.5)
 NULL
diff --git a/R/CharnetEx1.6.R b/R/CharnetEx1.6.R
index cbfe8b2..91cbd48 100644
--- a/R/CharnetEx1.6.R
+++ b/R/CharnetEx1.6.R
@@ -1,6 +1,6 @@
 #' @name CharnetEx1.6
 #' 
-#' @title Pressão sanguínea sistólica
+#' @title Pressão Sanguínea Sistólica
 #' 
 #' @description Pressão sanguínea sistólica de um grupo de 16 pacientes
 #'     de uma clínica.
@@ -18,8 +18,14 @@
 #'
 #' data(CharnetEx1.6)
 #'
-#' mean(CharnetEx1.6)
-#' sd(CharnetEx1.6)
+#' (m <- mean(CharnetEx1.6))
+#' (s <- sd(CharnetEx1.6))
 #' fivenum(CharnetEx1.6)
+#'
+#' curve(dnorm(x, m, s),
+#'       xlim = extendrange(CharnetEx1.6, f = 0.2),
+#'       col = 4, lwd = 2)
+#' hist(CharnetEx1.6, prob = TRUE, add = TRUE)
+#' rug(CharnetEx1.6)
 #' 
-NULL
\ No newline at end of file
+NULL
diff --git a/R/CharnetEx2.10.R b/R/CharnetEx2.10.R
index 26e143e..b386d28 100644
--- a/R/CharnetEx2.10.R
+++ b/R/CharnetEx2.10.R
@@ -1,17 +1,18 @@
 #' @name CharnetEx2.10
 #' 
-#' @title Estudo do efeito do Carbono na Resistência Elétrica
+#' @title Estudo do Efeito do Carbono na Resistência Elétrica
 #' 
-#' @description Estudo do efeito do Carbono na Resistência Elétrica na
-#'              temperatura de 20ºC
+#' @description Estudo sobre o efeito do carbono contido, em fios de aço
+#'     em resistência elétrica, na temperatura de 20ºC.
 #'
 #' @format Um \code{data.frame} com 2 colunas e 15 linhas.
 #'
 #' \describe{
 #'
-#' \item{\code{carb}}{Porcentagem de carbono em fios de aço}
+#' \item{\code{carb}}{Porcentagem de carbono nos fios de aço.}
 #'
-#' \item{\code{res}}{Resistência elétrica em ohms a 20ºC}
+#' \item{\code{res}}{Resistência elétrica, mensurada em \eqn{\mu} ohms
+#'     cm a 20ºC.}
 #'
 #' }
 #'
@@ -26,6 +27,7 @@
 #'
 #' data(CharnetEx2.10)
 #'
-#'plot(CharnetEx2.10)
+#' plot(CharnetEx2.10)
+#' abline(lm(res ~ carb, data = CharnetEx2.10))
 #'
-NULL
\ No newline at end of file
+NULL
diff --git a/R/CharnetEx2.9.R b/R/CharnetEx2.9.R
index faff72b..91be414 100644
--- a/R/CharnetEx2.9.R
+++ b/R/CharnetEx2.9.R
@@ -1,15 +1,15 @@
 #' @name CharnetEx2.9
 #' 
-#' @title Notas de candidatos ao vestibular
+#' @title Notas de Candidatos ao Vestibular
 #' 
-#' @description Notas de 9 candidatos ao vestibular nas provas de 
-#'              Matemática e Física.
+#' @description Notas de 9 candidatos ao vestibular nas provas de
+#'     Matemática e Física.
 #'
 #' @format Um \code{data.frame} com 2 colunas e 9 linhas.
 #'
 #' \describe{
 #'
-#' \item{\code{prova}}{Área da prova no vestibular}
+#' \item{\code{prova}}{Área da prova no vestibular.}
 #'
 #' \item{\code{nota}}{Nota obtida no teste, em escala de 0 a 100.}
 #'
@@ -25,7 +25,13 @@
 #' @examples
 #'
 #' data(CharnetEx2.9)
-#' 
+#'
 #' plot(CharnetEx2.9)
 #'
-NULL
\ No newline at end of file
+#' # Dados no formato largo (wide) para visualização dos pares
+#' data.wide <- unstack(CharnetEx2.9, form = nota ~ prova)
+#'
+#' plot(data.wide)
+#' abline(a = 0, b = 1)
+#'
+NULL
diff --git a/man/CharnetEx1.20.Rd b/man/CharnetEx1.20.Rd
new file mode 100644
index 0000000..59fb532
--- /dev/null
+++ b/man/CharnetEx1.20.Rd
@@ -0,0 +1,33 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/CharnetEx1.20.R
+\name{CharnetEx1.20}
+\alias{CharnetEx1.20}
+\title{Testes de Avaliação de Personalidade}
+\format{Um \code{data.frame} com 2 colunas e 20 linhas.
+
+\describe{
+
+\item{\code{t1}}{Resultados do teste I, em pontos.}
+
+\item{\code{t2}}{Resultados do teste II, em pontos.}
+
+}}
+\source{
+Charnet, R., de Luna Freire, C.A., Charnet, E.M.R. & Bonvino,
+    H. (2008). Análise de modelos de regressão linear com aplicações
+    (2nd ed., p. 356). SP: Editora Unicamp (Capítulo 1, exercício 20,
+    página 26)
+}
+\description{
+Dois testes de avaliação de personalidade aplicados a 20
+    indivíduos.
+}
+\examples{
+
+data(CharnetEx1.20)
+
+plot(CharnetEx1.20)
+
+}
+\keyword{TODO}
+
diff --git a/man/CharnetEx1.5.Rd b/man/CharnetEx1.5.Rd
new file mode 100644
index 0000000..5c33092
--- /dev/null
+++ b/man/CharnetEx1.5.Rd
@@ -0,0 +1,32 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/CharnetEx1.5.R
+\name{CharnetEx1.5}
+\alias{CharnetEx1.5}
+\title{Tempo de Duração do Intervalo para o Cafezinho}
+\format{Um \code{vetor} numérico com 20 observações.}
+\source{
+Charnet, R., de Luna Freire, C.A., Charnet, E.M.R. & Bonvino,
+    H. (2008). Análise de modelos de regressão linear com aplicações
+    (2nd ed., p. 356). SP: Editora Unicamp (Capítulo 1, exercício 5,
+    pág. 23)
+}
+\description{
+Tempo de duração do intervalo para o cafezinho para uma
+    amostra de 20 empregados de uma grande empresa.
+}
+\examples{
+
+data(CharnetEx1.5)
+
+(m <- mean(CharnetEx1.5))
+(s <- sd(CharnetEx1.5))
+fivenum(CharnetEx1.5)
+
+curve(dnorm(x, m, s),
+      xlim = extendrange(CharnetEx1.5, f = 0.2),
+      col = 4, lwd = 2)
+hist(CharnetEx1.5, prob = TRUE, add = TRUE)
+rug(CharnetEx1.5)
+}
+\keyword{amostra}
+
diff --git a/man/CharnetEx1.6.Rd b/man/CharnetEx1.6.Rd
new file mode 100644
index 0000000..7cada09
--- /dev/null
+++ b/man/CharnetEx1.6.Rd
@@ -0,0 +1,33 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/CharnetEx1.6.R
+\name{CharnetEx1.6}
+\alias{CharnetEx1.6}
+\title{Pressão Sanguínea Sistólica}
+\format{Um \code{vetor} numérico com 16 observações.}
+\source{
+Charnet, R., de Luna Freire, C.A., Charnet, E.M.R. & Bonvino,
+    H. (2008). Análise de modelos de regressão linear com aplicações
+    (2nd ed., p. 356). SP: Editora Unicamp (Capítulo 1, exercício 6,
+    página 23)
+}
+\description{
+Pressão sanguínea sistólica de um grupo de 16 pacientes
+    de uma clínica.
+}
+\examples{
+
+data(CharnetEx1.6)
+
+(m <- mean(CharnetEx1.6))
+(s <- sd(CharnetEx1.6))
+fivenum(CharnetEx1.6)
+
+curve(dnorm(x, m, s),
+      xlim = extendrange(CharnetEx1.6, f = 0.2),
+      col = 4, lwd = 2)
+hist(CharnetEx1.6, prob = TRUE, add = TRUE)
+rug(CharnetEx1.6)
+
+}
+\keyword{amostra}
+
diff --git a/man/CharnetEx2.10.Rd b/man/CharnetEx2.10.Rd
new file mode 100644
index 0000000..2c5f408
--- /dev/null
+++ b/man/CharnetEx2.10.Rd
@@ -0,0 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/CharnetEx2.10.R
+\name{CharnetEx2.10}
+\alias{CharnetEx2.10}
+\title{Estudo do Efeito do Carbono na Resistência Elétrica}
+\format{Um \code{data.frame} com 2 colunas e 15 linhas.
+
+\describe{
+
+\item{\code{carb}}{Porcentagem de carbono nos fios de aço.}
+
+\item{\code{res}}{Resistência elétrica, mensurada em \eqn{\mu} ohms
+    cm a 20ºC.}
+
+}}
+\source{
+Charnet, R., de Luna Freire, C.A., Charnet, E.M.R. & Bonvino,
+    H. (2008). Análise de modelos de regressão linear com aplicações
+    (2nd ed., p. 356). SP: Editora Unicamp (Capítulo 2, exercício 10,
+    página 47)
+}
+\description{
+Estudo sobre o efeito do carbono contido, em fios de aço
+    em resistência elétrica, na temperatura de 20ºC.
+}
+\examples{
+
+data(CharnetEx2.10)
+
+plot(CharnetEx2.10)
+abline(lm(res ~ carb, data = CharnetEx2.10))
+
+}
+\keyword{TODO}
+
diff --git a/man/CharnetEx2.9.Rd b/man/CharnetEx2.9.Rd
new file mode 100644
index 0000000..55159d8
--- /dev/null
+++ b/man/CharnetEx2.9.Rd
@@ -0,0 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/CharnetEx2.9.R
+\name{CharnetEx2.9}
+\alias{CharnetEx2.9}
+\title{Notas de Candidatos ao Vestibular}
+\format{Um \code{data.frame} com 2 colunas e 9 linhas.
+
+\describe{
+
+\item{\code{prova}}{Área da prova no vestibular.}
+
+\item{\code{nota}}{Nota obtida no teste, em escala de 0 a 100.}
+
+}}
+\source{
+Charnet, R., de Luna Freire, C.A., Charnet, E.M.R. & Bonvino,
+    H. (2008). Análise de modelos de regressão linear com aplicações
+    (2nd ed., p. 356). SP: Editora Unicamp (Capítulo 2, exercício 9,
+    página 47)
+}
+\description{
+Notas de 9 candidatos ao vestibular nas provas de
+    Matemática e Física.
+}
+\examples{
+
+data(CharnetEx2.9)
+
+plot(CharnetEx2.9)
+
+# Dados no formato largo (wide) para visualização dos pares
+data.wide <- unstack(CharnetEx2.9, form = nota ~ prova)
+
+plot(data.wide)
+abline(a = 0, b = 1)
+
+}
+\keyword{TODO}
+
-- 
GitLab