Skip to content
Snippets Groups Projects
Commit ab90de02 authored by Walmes Marques Zeviani's avatar Walmes Marques Zeviani
Browse files

Inicia o pacote labestData.

parents
No related branches found
No related tags found
No related merge requests found
% Guia de Contribuição
% PET Estatística UFPR - <pet.estatistica.ufpr@gmail.com>
> "O segredo de progredir é começar. O segredo se começar é dividir as
> tarefas árduas e complicadas em tarefas pequenas e fáceis de executar
> e depois começar pela primeira."
>
>> -- Mark Twain
## Para que serve um Guia de Contribuição? ##
O Guia de Contribuição Serve para orientar a forma de trabalhar, tanto
individual quanto em equipe, para que seja eficiente, padronizada,
coordenada e segura. Ele estabelece as regras e etapas principais do
deselvolvimento de um projeto. O Guia de Contribuição incluí orientações
de como escrever o código, mensagens de commit, etc TODO
Interessados em participar do projeto devem se orientar pelo Guia de
Contribuição sobre como o desenvolvimento acontece, das tarefas às
responsabilidades dos indivíduos e equipes, das etapas e prazos aos
resultados do projeto.
## O que é um fluxo de trabalho? ##
O fluxo de trabalho é a sequência de etapas que devem ser cumpridas para
atingir um resultado.
## Qual é o fluxo de trabalho do *labestData*?
1. Criar um *issue* para o Projeto no GitLab. Ao criar o *issue*,
dedique-se para escrever uma detalhada descrição do trabalho a ser
feito. Isso informa a equipe sobre onde você irá trabalhar para que
não se dublique os esforços. Todo issue têm um número associado,
como `#7` e isso deve ser usado nas comunicações.
2. Faça uma atualização do seu ramo `devel` local com o ramo `devel`
do projeto no GitLab (atualize o HEAD). Isso pode ser feito com o
comando `git pull` ou com `git fetch + git merge`. Em caso de
insegurança, visite a Apostila de Git do PET Estatística.
3. Crie um *branch* para começar o trabalho que você descreveu no
*issue* que acabou de criar. O nome do ramo deve ser `issue#?`, em
que `'?` representa o número do *issue*, por exemplo,
`issue#321`. Usar es'ses nomes facilita para os membros descobrirem
do se se trata esse *branch*, pois basta consultar o *issue* de
mesmo número.
4. Faça o trabalho que descreveu. Nessa etapa você senta na frente do
computador e escreve e isso envolve os seguintes passos:
1. Escreve, corrija, aperfeiçoe, amplie, revise, organize, limpe,
etc. Faça o trabalho.
2. Faça *commits* com regularidade, de preferência, por unidades de
trabalho para as quais se tem um significado claro - uma unidade
de trabalho comitável - que possa ser expresso sem prejuízo por
uma frase curta ou por uma lista de frases curtas. Quando não
souber se já possuí uma unidade de trabalho merecedora de
*commit*, faça o *commit* do mesmo jeito. Não seja precioso com
isso. No entanto, seja caprichoso ao fazer a sua mensagem de
*commit* para garentir que esteja em conformidade com o guia de
boas práticas.
3. Em intervalos maiores, mas ainda com frequência, suba seu
trabalho para o repositório. Isso se faz com o comando `git
push`. É importante fazer sempre para evitar de perder o
trabalho da sua máquina que está sujeita a avaria.
6. Quando cumprir com o trabalho previsto no seu *issue*, dê o push
final e faça uma requisição de mescla - um *merge request* (MR). Ao
criar o MR, assim como foi para o *issue*, existe um espaço para a
descrição de tudo o que o *branch*. Basicamente isso é um resumo de
todos os *commits* feitos. Embora a descrição do *issue* informe o
que estava previsto fazer, isso não significa que tudo foi
feito. Você pode ter feito trabalho a mais, ou visto que algo não
foi necessário. Então relate na descrição do MR exatamente o
que será adicionado ao ramo alvo. Os MR devem ser para o ramo
`devel` e devem ser atribuídos à outra pessoa.
7. Aguarde a avaliação do MR. Nessa etapa quem trabalha é o *merger* -
colaborador responsável por avaliar o seu *branch* e aplicar o
*merge*. Em caso de aprovação, o *merge* será aplicado. Em caso
contrário, você será notificado.
8. Se o MR não foi aceito, o *merger* vai informar o que fazer com
mensagem abaixo da descrição do merge. Faça as adequações
solicitadas. Retome da etapa 4.
9. Quando o MR for aprovado, feche o *issue* correspondente. Indique
na mensagem de fechamento do *issue* qual foi o número do MR
dele. Os ramos de demanda - com prefixo *issue* - são removidos
após o *merge* mas os *issues* e os MR - que junto com os *commits*
contam a trajetória do projeto - permanem no GitLab.
## O que é um Guia de Estilo de Código? ##
Um Guia de Estilo de Código é um conjunto de recomendações (ou regras)
para padronizar a forma de escrever código. Códigos que são escritos
seguindo um estilo padrão são mais fáceis de manter, modificar e
garantir que estão corretamente escritos e funcionais, principalmente
quando muitos programadores estão envolvidos.
Quase todas as linguagem de programação permitem que os usuários adotem
diferentes padrões de escrita de código. Algumas não diferenciam
maiúsculas e outras não exigem indentação, por exemplo. Em função de
simplicidade, comodismo ou inércia na hora de escrever ou de
características da linguagem ou do editor, os usuários quase sempre tem
padrão particular para escrita de código.
## Qual o guia de estilo de código? ##
No pacote *labestData* deve ser considerado o idiom padrão do R,
descrito no [STYLEGUIDE.md].
## Como dar nome aos datasets? ##
No caso de datasets de livros (obras impressas), o nome do dataset é
formado pelo sobrenome do primeiro autor seguido da indentificação da
tabela na obra. Considera os exemplos
* ZimmermannTb8.2: Tabela 8.2 do Zimmermann (2004);
* RamalhoTb4.3: Tabela 3 do capítulo 4 em Ramalho, Ferreira e Oliveira
(2005). Nesse livro as tabelas tem numeração reiniciada em todo
capítulo e por isso adiciona-se o numeral do capítulo para evitar
ambiguidade, já que vários capítulos podem ter a tabela 1.
* BanzattoQd3.6.1: Quadro 3.6.1 do Banzatto e Kronka (2013). Este
livro usa o nome quadro ao invés de tabela.
* DiasEx10.7: Exercício 7 do capítulo 10 em Dias e Barros (2009). Os
exercício são númerados dentro dos capítulos então adiciona-se o
digito do capítulo para não haver ambiguidade.
* StorkEg2.3.5: Exemplo 2.3.4 do Stork et al. (2011). Para não
confundir Exercício e Exemplo, consideramos abreviar com Eg de
*exempli gratia*.
* BarbinPg52: Tabela sem legenda na página 52 do Barbin (2013). Nesse
caso identifica-se usando a página. No caso de várias tabelas na
mesma página, use mais um digito separado por ponto: Pg52.1 e
Pg52.2.
* PimentelPg142: Dados em Pimentel-Gomes (2009) que estão em tabelas
distribuidas em duas páginas mas não tem legenda, assim usa-se o
número da primeira página.
A prioridade na hora de atribuir a identificação é a seguinte: Tabela =
Quadro > Exemplo = Exercício > Página. Ou seja, se a tabela 5 faz parte
do exemplo 3 que está na página 122, o nome do dataset terá sulfixo
Tb5. Note que uma página pode ter mais de uma tabela, bem como um
exemplo. Além do mais, diferentes edições podem preservar com mais
facilidade a numeração das tabelas do que a localização delas nas mesmas
páginas. Sendo assim, um dataset só será identificado como sulfixo Ex ou
Eg se não tiver legenda (Tabela ou Quadro) e só será identificado pela
página se não houver outra alternativa.
## Como formatar as variáveis? ##
O nome das variáveis não deve conter acentos (ASCII pleno), não pode
iniciar com número e só admite o underline como não alfanumérico. As
variáveis de nome composto e longo poder ser representadas por siglas, e
as de nome simples mas longo, por abreviação. Veja a tabela com
exemplos.
| Variável resposta | Nome da coluna |
|---------------------------+----------------|
| Dias | dias |
| Idade | idade |
| Renda | renda |
| Produtividade | prod |
| Temperatura | temp |
| Pressão sanguínea | ps |
| Massa seca de parte aérea | mspa |
## O que colocar na documentação? ##
Os datasets devem ter uma documentação precisa. Existem vários campos da
documentação que podem ser usados, no entanto, alguns poucos são
sufícientes minimo. TODO
Abaixo tem-se a documentação do *data.frame* `RamalhoTb4.7`. Embora os campos
sejam praticamente autoexplicativos, segue breve explicação.
* `@name`: o nome do dataset.
* `@title`: título que representa o dataset.
* `@description`: descrição do conjunto de dados. Pode conter mais de
um parágrafo.
* `@format `: forma e conteúdo do dataset. Informa as dimensões e cada
uma das variáveis (nome, descrição, unidade de medida, tipo de
valor).
* `@keywords`: palavras que classificam o dataset, como o tipo de
variável resposta e delineamento (ex: DIC, DQL, contagem,
proporção). Elas aparecem no índice remissivo no manual em PDF.
* `@source`: indica a fonte dos dados. Normalmente é a referência
bibliográfia, a url do endereço de origem ou o nome proprietário dos
dados (indivíduo, grupo ou instituição).
* `@examples`: contém código R que produz gráficos e tabelas com os
dados.
```
#' @name RamalhoTb4.7
#' @title Produção de arrozeiro em função de cultivares
#'
#' @description Produção em função de cultivares de arroz em um
#' experimento instalado em delineamento de blocos casualidados.
#'
#' @format Um data.frame com 30 linhas e 3 colunas.
#'
#' \describe{
#'
#' \item{\code{bloco}}{Blocos do experimento com 3 níveis
#' qualitativos. Sua função é de controle local.}
#'
#' \item{\code{cultivar}}{Fator de interesse com 10 níveis
#' qualitativos. São as cultivares de arroz estudadas no
#' experimento.}
#'
#' \item{\code{producao}}{Produção de arroz medida em cada parcela
#' (kg/ha).}
#'
#' }
#'
#' @keywords DBC arroz
#'
#' @source Ramalho, M. A. P., Ferreira, D. F., & Oliveira,
#' A. C. de. (2005). Experimentação em genética e melhoramento de
#' plantas (2nd ed., p. 322). Editora UFLA. (tabela 7, página 62)
#'
#' @examples
#'
#' library(lattice)
#' data(RamalhoTb4.7)
#'
#' xyplot(producao ~ cultivar, groups = bloco, data = RamalhoTb4.7,
#' ylab="Produção (kg/ha)", xlab="Cultivar")
#'
NULL
```
Por razão ainda desconhecida, títulos com acentos são substituídos por
NA no manual em PDF. Na documentação em HTML, no entanto, e produzida
sem erros.
<!--
<http://ase-research.org/R/>
<http://r-pkgs.had.co.nz/man.html#man-data>
-->
<!------------------------------------------- -->
## Como criar um *branch*? ##
Um *branch* é criado de duas formas, conforme abaixo.
```
# Com duas instruções.
git branch novo # cria
git checkout novo # move
# Com uma instruções 2 em 1
git checkout -b novo
```
## Como criar um *issue*? ##
De uma maneira simples, um *issue* é uma tarefa. Quando você cria um
*issue*, você está documentando algo que precisa ser feito. Essas
tarefas podem ser relacionadas à criação ou correção no seu pacote.
Na página do repositório existe uma entrada chama
[*Issues*](https://gitlab.c3sl.ufpr.br/pet-estatistica/labesData/issues)
no menu esquerdo. Ao entrar nessa página, existe um botão de create
[new issue](https://gitlab.c3sl.ufpr.br/pet-estatistica/iguir2/issues/new?).
Na página de criar um *issue*, você deve preencher os seguintes campos:
* Title: com um título que representa o seu *issue*.
* Description: com uma descrição detalhada do que deve ser feito no
*issue*.
* Assignee: com quem é o responsável pelo desenvolvimento do issue*.
* Milestone: com a marca de milha a que o *issue* pertence, se alguma.
* Labels: com as palavras chaves apropriadas para o *issue*, se
alguma.
Feito isso, clique em *Submit issue*.
## Quanto de trabalho representa um *issue*? ##
É difícil ser preciso nisso, mas aconselha-se que no *labestData* um
*issue* 1) seja o trabalho correspondente a duas horas de dedicação ou,
ainda que o tempo estimado não seja perto desse, que 2) seja uma unidade
característica de trabalho que não vale a pena dividir em mais *issues*.
A última situação ocorre, por exemplo, quando você precisa criar uma
grande função, que demora por volta de 5 horas de trabalho. Uma
dedicação de 2 horas pode não ter uma função pronta que passe nas
verificações de *build*. No primeiro caso, por outro lado, se o trabalho
é texto, por exemplo, mesmo que este esteja incompleto a verificação de
*build* ser verde.
## Como fechar ou editar um issue ##
Para editar, basta acessar o menu
[*Issues*](https://gitlab.c3sl.ufpr.br/pet-estatistica/labesData/issues)
e abrir o *issue* desejado. A edição permite editar praticamente tudo,
embora seja desaconselhado modificar o título e descrição do
mesmo. Deve-se dedicar na hora de atribuir título e descriação para que
sejam apropriados e sem necessidade de mudar.
Na página de um *issue* é possível fazer uma discussão sobre ele, bem
como atribuir a outro colaborador. Quandor o issue for concluído,
deve-se fechá-lo.
## Como fazer mensagens de *commit*? ##
Começar com verbo no imperativo.
## Como criar um *merge request*? ##
Criar um *merge request* (requisição de junção), acesse o menu
[*Merge resquest*](https://gitlab.c3sl.ufpr.br/pet-estatistica/labestData/merge_requests)
e preencha de forma semelhante ao que se faz com o *issue*.
Note que a descrição do *issue* representa o será feito e do *merge
request* o que foi feito.
## Quais as exigências para aceitar um *MR*? ##
Para que um *merge request* seja aceito, 3 condições precisam ser
satisfeitas:
1. O trabalho deve estar concluído. Isso significa de o que previsto
precisa ser cumprido. Em caso de não conclusão, uma justificativa
deve ser dada e aceita. Se o trabalho foi mal dimensionado, abra um
*issue* no futuro para concluí-lo.
2. O *branch* tem que ter *build sucess*. A vantagem, dentre muitas,
da integração contínua, é sabermos se um ramo tem problemas de
código. Se um *branch* não passa nas verificações do *build*,
quando deveria passar, então algo está errado e precisa ser
consertado.
3. O trabalho deve estar em conformidade com o Guia de Estilo de
Código. Ainda que o *branch* esteja verde - com *build status*
positivo - o *merger* (pessoa responsável pelo *merge*) deve
inspecionar o seu código e verificar se está em conformidade com o
Guia de Estilo de Código. Não havendo conformidade, ele vai indicar
as correções a serem feitas.
## Existe um *checklist* para incluir um *dataset*? ##
Na lista que segue abaixo, dados representa o nome do dataset e o
diretório raíz é o `/labestData`.
1. Criar o `dados.txt`. Criar o arquivo texto com os dados no
diretório `./data-raw`. Usar TAB com separador de campo e ponto
como separador decimal.
2. Criar o `dados.rda`. Carregar o `dados.txt` e criar a imagem do
objeto (`*.rda` ou `*.RData`) no diretório `./data`. A forma mais
simples é usar a função `devtools::use_data(dados)`.
3. Fazer a documentação dos dados. Criar o arquivo `dados.R` no
diretório `./R/`.
4. Gerar o arquivo `dados.Rd`. Com o comando `devtools::document()`
gerar os arquivos de documentação que ficam no diretório
`./man`. Use `devtools::check_doc()` para verificar a documentação.
5. Por fim, execute `devtools::check()` e `devtools::build()`. Observe
se ocorrem notificações de `ERROR`, `WARNING` ou `NOTE`. Faça
correções para removê-las.
No final, você deve ter a essa estrutura de diretório abaixo
```
labestData/
|-- DESCRIPTION
|-- NAMESPACE
|-- data-raw/
| `-- dados.txt
|-- data/
| `-- dados.rda
|-- man/
| `-- dados.Rd
`-- R/
`-- dados.R
```
## Existe um *checklist* antes de submeter um MR? ##
1. As atividades do *issue* foram concluídas.
2. O código está de acordo com o Guia de Estilo de Código.
3. O `devtools::check()` e `devtools::build()` executam notificações
negativas.
4. O *branch* passa na integração contínua com *build status*
positivo.
Package: labestData
Title: Conjuntos de Dados para Ensino de Estatística
Version: 0.0-1
Authors@R: as.person(c(
"PET Estatística UFPR <pet.estatistica.ufpr@gmail.com> [cre]",
"Altamiro Antonio Basiewics <alfbasiewics@bol.com.br> [ctb]",
"Angela Luiza Cunha Legey <angelalegey@gmail.com> [ctb]",
"Bruna Davies Wundervald <brunadaviesw@gmail.com> [ctb]",
"Bruno Geronymo <geronymobruno@hotmail.com> [ctb]",
"Daniel Ikenaga <oladani@gmail.com> [ctb]",
"Eduardo Elias Ribeiro Junior <edujrrib@gmail.com> [ctb]",
"Gabriel Sartori Klostermann <gabrielsartori2008@gmail.com> [ctb]",
"Jhenifer Caetano Veloso <jhenicaet@gmail.com> [ctb]",
"Monica Ludmila Hintz De Oliveira <monica.ludmila@gmail.com> [ctb]",
"Paula Alessandra Zeizer Dimas <alessandra.zeizer@gmail.com> [ctb]",
"Alcides Conte Neto <neto_conte@hotmail.com> [ctb]",
"Walmes Marques Zeviani <walmes@ufpr.br> [ctb]",
"Cesar Augusto Taconeli <taconeli@ufpr.br> [ctb]"))
Description: O labestData é um projeto coletivo do PET Estatística UFPR
para desenvolver um pacote R com conjuntos de dados para ensino de
Estatística. Os objetivos desse projeto são 1) capacitar os membros
do PET Estatística a desenvolver pacote R com versionamento Git e 2)
contribuir com a comunidade científica ao reunir, organizar, manter
e disponibilizar conjuntos de dados disponíveis em livros, páginas
de internet e arquivos pessoais.
License: GPL-3
URL: http://gitlab.c3sl.ufpr.br/pet-estatistica/labestData
BugReports: http://gitlab.c3sl.ufpr.br/pet-estatistica/labestData/issues
LazyData: true
Encoding: UTF-8
Depends:
R (>= 3.2.3)
Suggests:
lattice
This diff is collapsed.
#' @name PimentelEg5.2
#' @title Competição de variedades de batatinha
#' @description Experimento de competição de variedades de batatinha
#' feito pelo Engenheiro Agrônomo Oscar A. Garay em Balcare,
#' Argentina. O experimento foi realizado em blocos casualizados.
#' @format data.frame com 32 observações e 3 variáveis, em que
#'
#' \describe{
#'
#' \item{bloco}{Fator de 4 níveis qualitativos, usado para
#' controle local.}
#'
#' \item{variedade}{Fator de 8 níveis qualitativos que são as variedades
#' de batatinha.}
#'
#' \item{producao}{Produção de batatinha, em ton ha\eqn{^{-1}}, nas
#' unidades experimentais.}
#'
#' }
#' @keywords DBC batatinha
#' @source Pimentel-Gomes, F. (2009). Curso de Estatístitica
#' Experimental (15th ed.). Piracicaba: FEALQ.
#' @examples
#'
#' library(lattice)
#'
#' xyplot(producao ~ variedade, groups = bloco, data = PimentelEg5.2,
#' type = "b",
#' ylab=expression(Produção~(t~ha^{-1})),
#' xlab="Variedades de batatinha")
#'
NULL
#' @name labestData
#' @title Conjuntos de Dados para Ensino de Estatística
#' @docType package
#' @description O labestData é um projeto coletivo do PET Estatística
#' UFPR para desenvolver um pacote R com conjuntos de dados para
#' ensino de Estatística. Os objetivos desse projeto são 1)
#' capacitar os membros do PET Estatística a desenvolver pacote R
#' com versionamento Git e 2) contribuir com a comunidade científica
#' ao reunir, organizar, manter e disponibilizar conjuntos de dados
#' disponíveis em livros, páginas de internet e arquivos pessoais.
#'
NULL
README.md 0 → 100644
% labestData
% PET Estatística UFPR - <pet.estatistica.ufpr@gmail.com>
> “Without data, you're just another person with an opinion.”
>
>> -- W. Edwards Deming
> “It is a capital mistake to theorize before one has data. Insensibly
> one begins to twist facts to suit theories, instead of theories to
> suit facts.”
>
>> -- Arthur Conan Doyle, Sherlock Holmes
## O que o *labestData*?
O *labestData* é um projeto coletivo do PET Estatística UFPR para
desenvolver um pacote R com conjuntos de dados para ensino de
Estatística.
## Quais são os objetivos do projeto *labestaData*?
O projeto tem dois objetivos principais:
1. Capacitar os membros do PET Estatística (bolsistas e voluntários)
a desenvolver pacote R com versionamento Git;
2. Contribuir com o Departamento de Estatística, e a comunidade
científica em geral, por reunir, organizar, manter e disponibilizar
conjuntos de dados na forma de um pacote R de tal forma que possam
ser usados para o ensino de Estatística.
## Quem são os desenvolvedores do *labestData*?
Os colaboradores do *labestData* são os bolsistas do PET, voluntários e
professores.
| | Tipo | 1 etapa | 2 etapa |
|----------------------------------+------------+---------+---------|
| Alcides Conte Neto | Voluntário | S | - |
| Altamiro Antonio Basiewics | Petiano | S | - |
| Angela Luiza Cunha Legey | Petiana | S | - |
| Bruna Davies Wundervald | Petiana | S | - |
| Bruno Geronymo | Petiano | S | - |
| Daniel Ikenaga | Petiano | S | - |
| Eduardo Elias Ribeiro Junior | Petiano | S | - |
| Gabriel Sartori Klostermann | Petiano | S | - |
| Jhenifer Caetano Veloso | Petiana | S | - |
| Monica Ludmila Hintz De Oliveira | Petiana | S | - |
| Paula Alessandra Zeizer Dimas | Petiana | S | - |
| Walmes Marques Zeviani | Professor | S | - |
| Cesar Augusto Taconeli | Professor | S | - |
## Como fazer para ser colaborar do *labestData*?
Colaborações são muito bem vindas. Para colaborar, entre em contato com
PET Estatística (<pet.estatistica.ufpr@gmail.com>, PC09, 04133613261) ou
com o Tutor (<walmes@ufpr.br>. 04133613573) comunicando a
intenção. Antes, no entanto, leia o Guia de Contribuição:
[CONTRIBUTING.md](./CONTRIBUTING.md).
## Quando é desenvolvido o pacote *labestData*?
O *labestData* foi planejado para ser desenvolvido em duas etapas. A
primeira etapa inicia em 29/02/2016 com duração de 10 semanas (fim em
06/05). A segunda inicia em 01/08/2016 com duração de 7 semanas (fim em
16/09).
## De onde serão obtidos os conjuntos de dados para o *labestData*?
Os dados a serem incluídos no pacote serão provenientes de 4 principais
fontes:
1. Livros. Os livros que exibem aplicações normalmente contém dados em
formas de tabela, em CD-Rom que acompanha o livro, pacote ou em
site com materiais suplementares. Essa será a maior fonte de dados
para o pacote labestData.
2. Internet. A internet está repleta de dados. Existem dados prontos
em formas de tabela (páginas pessoais, orgãos públicos, instiuições
de pesquisa, resultados de enquetes, etc) e também dados não
tabulados/organizados que podem ser capturados (com *web scrap*,
por exemplo) e processados.
3. Arquivos pessoais. Alunos, professores, pesquisadores também podem
disponibilizar os dados de suas pesquisas para inclusão no pacote.
4. Simulação. Embora sejam artificiais, dados proveninentes de
simulação podem ser considerados pois, muitas vezes, são
deliberadamente feitos com uma particular característica relevante
para um problema. No pacote labestData essa será a menor fonte de
dados.
Esses dados serão incluídos no pacote, logicamente, sendo feita uma
referências apropriada da fonte. Se a fonte for livro (site), será
indicado a obra (endereço) de tal forma que as pessoas possam encontrar
o original. Dados de arquivos pessoais também farão referência sobre os
proprietários dos dados, pessoas ou instituições.
## Quais os tipos de dados que serão considerados no *labestData*?
Por razões de conveniência, a primeira etapa do pacote irá priorizar
dados correspondentes às disciplinas de Análise de Regressão Linear
(CE071), Planjamento de Experimentos I (CE213) e Métodos Estatísticos
Multivariados (CE090). No Curso de Estatística da UFPR, essas
disciplinas são ofertadas no primeiro semestre. Na segunda etapa, os
dados irão priorizar as disciplinas de Modelos Lineares Generalizados
(CE225), Controle de Processos Industriais (CE074) e Extensões de
Modelos de Regressão (CE092). Essas disciplinas são ofertadas no segundo
semestre para o Curso de Estatística da UFPR.
Embora sejam esses os contextos de prioridade, dados de outras áreas são
igualmente bem vindos, como dados espaciais, séries temporais, de
análise de sobreviência, de questionário, etc.
Os dados reais devem possuir uma boa descrição das variáveis (nome,
unidade de medida, instrumento de medida usado, definição da unidade
experimental), dos objetivos do experimento/estudo, de algumas hipóteses
preliminares, da forma de condução do experimento/coleta de dados, das
condições de contorno do experimento, etc.
## O que o *labestData* possui além dos conjuntos de dados?
Além dos dados, o pacote possui vinhetas (**vignettes**) com estudos de
caso com os dados do pacote. Essas vinhetas são um guia simples de como
coordenar funções do R para analisar os dados. Embora as vinhetas sejam
para alguns dados, elas servem de inspiração ou roteiro para os demais
dados do pacote.
## Quem pode usar o *labestData*?
O *labestData* é um pacote livre para o uso. O estudante pode usar (e
deve) para praticar a execução de análises, os cientistas podem usar
como referência para análise dos dados de suas pesquisas e os
professores podem usar como ferramenta de ensino. Ao tornar público
qualquer material que use elementos do pacote, solicitamos que faça
citação do mesmo.
## Como citar o pacote *labestData*?
PET Estatística UFPR (2016). **labestData: conjuntos de dados para
ensino de estatística**. R package version x.y-z.
https://gitlab.c3sl.ufpr.br/pet-estatistica/labesData
@Manual{labestData2016,
title = {labestData: conjuntos de dados para ensino de estatística},
author = {PET Estatística UFPR},
year = {2016},
note = {R package version x.y-z},
url = {https://gitlab.c3sl.ufpr.br/pet-estatistica/labesData},
}
**Atenção**: x.y-z deve ser substituído pela versão considerada do
pacote.
## Como usar os conjuntos de dados do *labestData*?
Para usar os conjuntos de dados você precisa instalar o pacote. Existem
duas formas de fazer isso:
1. Instalando o pacote pelos arquivos fonte: você precisar baixar o
arquivo com os fontes (`labestData.tar.gz` para Linux e
`labestData.zip` para Windows) e, de dentro de uma sessão R,
instalar com
install.packages("labestData.tar.gz", repos = NULL)
2. Instalando a partir do endereço do repositório. Para isso você
precisa ter o pacote `devtools` instalado (com todas as suas
dependências). De dentro de uma sessão R, instale com
library(devtools)
install_git("https://gitlab.c3sl.ufpr.br/pet-estatistica/labesData.git")
Depois de instalado, basta carregar o pacote e chamar o conjunto de
dados que deseja usar.
library(labestData) # Carrega o pacote para sessão.
ls("package:labestData") # Lista os objetos do pacote.
data(dados) # Traz para área de trabalho um dataset.
str(dados) # Mostra a estrutura do dataset.
## Como reportar sugestões ou erros ao projeto *labestData*?
Você pode abrir *issues* no projeto *labestData* em dois repositórios:
1. No repositório principal dentro do GitLab do c3sl:
<https://gitlab.c3sl.ufpr.br/pet-estatistica/labesData/issues>.
Apenas usuários com conta no GitLab do c3sl podem abrir *issue*.
2. No repositório espelho no GitHub:
<https://github.com/pet-estatistica/labestData/issues>. Qualquer
usuário do GitHub pode abrir *issue*.
Caso você não tenha conta em nenhum dos dois serviços, nem se interessa
em abrir uma conta, envie sua sugestão/bug para o endereço
<pet.estatistica.ufpr@gmail.com>. Coloque no início título da mensagem
(*subject*) a palavra `[labestData]`, e.g. `[labesData] Dados com número
incorreto de observações`.
This diff is collapsed.
bloco variedade producao
I Kennebec 9.2
I Huinkul 21.1
I S. Rafalela 22.6
I Buena Vista 15.4
I B 25-50 E 12.7
I B 1-52 20
I B 116-51 23.1
I B 72-53 A 18
II Kennebec 13.4
II Huinkul 27
II S. Rafalela 29.9
II Buena Vista 11.9
II B 25-50 E 18
II B 1-52 21.1
II B 116-51 24.2
II B 72-53 A 24.6
III Kennebec 11
III Huinkul 26.4
III S. Rafalela 24.2
III Buena Vista 10.1
III B 25-50 E 18.2
III B 1-52 20
III B 116-51 26.4
III B 72-53 A 24
IV Kennebec 9.2
IV Huinkul 25.7
IV S. Rafalela 25.1
IV Buena Vista 12.3
IV B 25-50 E 17.1
IV B 1-52 28
IV B 116-51 16.3
IV B 72-53 A 24.6
File added
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/PimentelEg5.2.R
\name{PimentelEg5.2}
\alias{PimentelEg5.2}
\title{Competição de variedades de batatinha}
\format{data.frame com 32 observações e 3 variáveis, em que
\describe{
\item{bloco}{Fator de 4 níveis qualitativos, usado para
controle local.}
\item{variedade}{Fator de 8 níveis qualitativos que são as variedades
de batatinha.}
\item{producao}{Produção de batatinha, em ton ha\eqn{^{-1}}, nas
unidades experimentais.}
}}
\source{
Pimentel-Gomes, F. (2009). Curso de Estatístitica
Experimental (15th ed.). Piracicaba: FEALQ.
}
\description{
Experimento de competição de variedades de batatinha
feito pelo Engenheiro Agrônomo Oscar A. Garay em Balcare,
Argentina. O experimento foi realizado em blocos casualizados.
}
\examples{
library(lattice)
xyplot(producao ~ variedade, groups = bloco, data = PimentelEg5.2,
type = "b",
ylab=expression(Produção~(t~ha^{-1})),
xlab="Variedades de batatinha")
}
\keyword{DBC}
\keyword{batatinha}
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/labestData.R
\docType{package}
\name{labestData}
\alias{labestData}
\alias{labestData-package}
\title{Conjuntos de Dados para Ensino de Estatística}
\description{
O labestData é um projeto coletivo do PET Estatística
UFPR para desenvolver um pacote R com conjuntos de dados para
ensino de Estatística. Os objetivos desse projeto são 1)
capacitar os membros do PET Estatística a desenvolver pacote R
com versionamento Git e 2) contribuir com a comunidade científica
ao reunir, organizar, manter e disponibilizar conjuntos de dados
disponíveis em livros, páginas de internet e arquivos pessoais.
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment