forked from BrunoVilela/NUPEX
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
55 lines (43 loc) · 1.77 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# NUPEX
<!-- badges: start -->
[](https://travis-ci.com/BrunoVilela/NUPEX)
[](https://ci.appveyor.com/project/BrunoVilela/NUPEX)
[](https://codecov.io/gh/BrunoVilela/NUPEX?branch=master)
<!-- badges: end -->
The goal of NUPEX package is to help with analysis of academic output from the Brazilian lattes platform and from other administrative sources.
## Installation
You can install the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("BrunoVilela/NUPEX")
```
## Example
This is a basic example of how to obtain all data from a lattes XML file:
```{r example, eval = FALSE}
library(NUPEX)
# Path to the XML file
path_lattes <- paste0(system.file("lattes",
package = "NUPEX"),
"/lattes1.xml")
# Run the main function to obtain all lattes data into a list of tables
lattes_data <- get_lattes(path_lattes)
```
This is an example to obtain lattes data from multiple XMLs:
```{r example2, eval = FALSE}
# Path to the XMLs files
path_lattes_folder <- system.file("lattes", package = "NUPEX")
# Run the main function to obtain all lattes data into a list of tables
lattes_data_multiple <- get_lattes_folder(path_lattes_folder)
```