-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
142 lines (98 loc) · 5.99 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
---
title: "ARIA: Tools to Analyze and Update Sistec Datasets"
output:
github_document:
fig_width: 9
fig_height: 5
---
[](https://travis-ci.org/r-ifpe/ARIA)
[](https://cran.r-project.org/package=ARIA)
[](https://github.com/R-IFPE/ARIA/actions)
[](https://github.com/R-IFPE/ARIA/actions)
[](https://circleci.com/gh/r-ifpe/ARIA)
[<img src="tools/readme/brasil_icon.png" width=22 height=22>](https://github.com/r-ifpe/ARIA/blob/master/LEIAME.md)
```{r setup, include=FALSE}
knitr::opts_chunk$set(eval = FALSE)
knitr::opts_chunk$set(warning = FALSE)
```
The [Sistec](https://sistec.mec.gov.br/) is the Brazilian system for diploma registration and validation on technical and superior courses. The sistec package provides tools for Brazilian institutions to update the student's registration and make data analysis about their situation, retention and drop out.
## Installation
You can install the sistec package from [CRAN](https://CRAN.r-project.org) as follows:
```{r, eval=FALSE}
install.packages("ARIA")
```
To upgrade to the latest version of sistec, run the following command and restart your R session:
```{r, eval=FALSE}
install.packages("devtools")
devtools::install_github("r-ifpe/ARIA")
```
Load the package.
```{r eval=FALSE}
library(ARIA)
```
## Sistec datasets
You can download the Sistec's student registration using your proper account on Sistec. The package provides support if your data comes from [setec](http://portal.mec.gov.br/setec-secretaria-de-educacao-profissional-e-tecnologica) or [web](https://sistec.mec.gov.br/).
Be sure that your data has these variables:
- On setec: "Nome Aluno", "Numero Cpf", "Co Ciclo Matricula", "Situacao Matricula",
"No Curso", "Dt Data Inicio" and "Unidade Ensino".
- On web: "NO_ALUNO", "NU_CPF", "CO_CICLO_MATRICULA", "NO_STATUS_MATRICULA", "NO_CICLO_MATRICULA", "DT_DATA_INICIO" and "CO_UNIDADE_ENSINO".
Tip: To take every student for your institution/campus using web, search by student name and use " ".
## Qacademico datasets
To download the student's data, go to your proper account on Qacademico and follow:
- "Relatorio de Alunos" --> "Listagem de Alunos" (choose year and period)
- Click on "visualizar"
- Using f10 shortcut and save in .csv format.
- Rename the including year and period (example2020_1.csv)
Be sure that your data has the variables: "Matricula", "Nome", "Situacao Matricula", "Curso", "Cpf", "Instituicao", "Per. Letivo Inicial" and "Cota".
## Sigaa datasets
Sigaa datasets can be partial or complete. These two formats can perform the comparison,
but the partial doesn't have information about "Campus" and "Cota".
To download the partial Sigaa's data, go to your proper account on Sigaa and follow:
- Access the panel "Consultas" inside Sigaa module;
- Generate the report "Consulta geral discentes";
- Select the check box "Trazer informações em forma de relatório" e "Gerar csv";
- Select the filter "Campus" and other filter you desire;
- Click on "Buscar" and download the file.
For the complete dataset, you have to download directly from the Sigaa database. Be
sure that your data has the variables: "Matricula", "Nome", "Situacao Matricula",
"Curso", "Cpf", "Instituicao", "ano_ingresso", "semestre_ingresso" and "Cota".
## Conecta datasets
To download Conecta datasets from the database follow these steps:
- Access "Curr\u00edculo e Oferta" -> "Matrizes Curriculares" -> "Anexos" -> "Consulta SQL";
- Select a view that contains the variables: "RA", "NOME_ALUNO", "STATUS_NO_CURSO", "Cota Chamado", "NOME_CURSO", "CPF", "NOME_CAMPUS", "DATA_INGRESSO_CURSO".
## Generic datasets
If your institute is not fully integrated with the package, you can transform your
academic database into a generic layout and use `read_rfept()` normally.
To transform your database in a generic rfept layout, follow these
requirements:
- Rename your columns to: NO_ALUNO, NU_CPF, CO_MATRICULA, NO_STATUS_MATRICULA,
NO_CURSO, DT_INICIO_CURSO, NO_CAMPUS and NO_COTA;
- All variables should be inherited to string class;
- The CPF's should be in xxx.xxx.xxx-xx format;
- The beginning date should be in yyyy.s format. Ex.: 2020.1. Use 1 for first
semester and 2 for second.
- Convert the student's status to valid name in Sistec, use: ABANDONO, EM_CURSO,
CONCLUÍDA, DESLIGADO, INTEGRALIZADA, REPROVADA and TRANSF_EXT;
- Save your data in a single file in csv format separated by comma and use
latin1 encoding. Semicolons separators and UTF-8 enconding are also available.
## Read files
Load the sistec package and pass the folder path to `read_sistec()` and `read_rfept()` functions. (**NOTE**: These datasets were generated randomly and do not represent the reality, it is just for example purpose).
```{r eval=FALSE}
sistec <- read_sistec(system.file("extdata/examples/sistec", package = "ARIA"))
qacademico <- read_rfept(system.file("extdata/examples/qacademico", package = "ARIA"))
```
## Comparison
Compare the student's situation using `compare_sistec()`
```{r eval=FALSE}
comparison <- compare_sistec(sistec, qacademico)
```
## Save results
You can save the comparison in .xlsx format using `write_output()`
```{r eval=FALSE}
write_output(output_path = "your_folder",
output_folder_name = "the_name_you_want",
comparison = comparison)
```
## ARIA web interface
ARIA is the web interface created in this package to ease your work. You can use all those functions just clicking in a few buttons. The ARIA is available on version [desktop](https://www.dropbox.com/sh/2bv2h49i8qfbzs9/AAA7MBfaZepyLMc5saDAEEo1a?dl=0), [online](https://aria.ifpe.edu.br) or run `aria()` in your R session.
<img src="tools/readme/aria_0.2.0.png" class="screenshot" width=800 />