-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
159 lines (106 loc) · 6.14 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
---
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%"
)
```
# matriz <img src="man/figures/logo.png" align="right" height="275"/>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=matriz)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://app.codecov.io/gh/jpmonteagudo28/matriz)
[](https://cran.r-project.org/package=matriz)
<!-- badges: end -->
The goal of `matriz` is to help you easily generate and manage structured literature review matrices in R. The package aims to streamline your research synthesis, track key study details, and organize citations efficiently.
## Installation
You can install the development version of matriz like so:
``` r
devtools::install_github("jpmonteagudo28/matriz)
```
or you can download it from CRAN:
``` r
install.packages("matriz")
```
## Intro
This document walks through the main steps of using `matriz`, from setting up your matrix to searching and refining it.
#### Importing Literature Matrices
The first step is to bring your literature data into R. If you have an existing matrix in CSV or another format, use the `import_matrix()` function. Otherwise, create an empty matrix using `init_matrix()`:
```{r example}
library(matriz)
lit_matrix <- init_matrix()
# Get matriz structure to guide in creating records
matriz_names()
# Start filling out individual record with article info
article <- data.frame(year = 2025,
citation = " ",
keywords = " ",
profession = "underwater basket weaver",
electronic = "YES",
purpose = "To investigate the depth of the oceans and retireve weaving materials",
study_design = "ethnography",
outcome_var = "perceived attitudes towards basket weaving",
predictor_var = NA,
sample = "a small school of clown fish",
setting = "Italy",
drop_rate = 0.13,
inclusion_criteria = "clow fish in Adriatic Sea",
ehtnicity = "oceanic",
age = "0 - 1 year",
sex = "both",
income = " ",
education = "none",
measures = "perceived attitudes",
analysis = "qualitative",
results = "no significant differences",
limitations = "small sample size",
implications = "clow fish don't like humans taking their homes for their own basket weaving endeavors",
ethical_concerns = "no informed consent given to school of clown fish",
biases = "clownfish always try to be funny. Lack of seriounness",
notes = "more research needed")
# Process and add the citation to the current record
bibtex <- system.file("examples","example.bib",package = "matriz")
cited_article <- process_citation(article,bibtex)
# Add the record to the literature matrix
lit_matrix <- add_record(lit_matrix, cited_article, .before = 1)
# Update record if mistake was made
lit_matrix <- update_record(lit_matrix, notes, where = year == 2025, set_to = "actually, the clow fish don't want us to come back.")
```
#### Merging Matrices
If you have multiple literature matrices and need to combine them, use `merge_matrix()`if you intend to combine matrices with dissimilar column names. If you are joining two equal matrices with distinct articles, use `add_record()` to add one record at a time or `add_batch_record()` to add multiple article summaries at once.
>**Note**: If your article summaries are lists and their element classes differ from those in the init_matrix data frame, using add_batch_record() may coerce all elements to lists instead of preserving their original classes.
```{r merging}
# Merge two literature matrices by a common column (e.g., "study_id")
additional_matrix <- lit_matrix
combined_matrix <- merge_matrix(lit_matrix, additional_matrix, by = "year", all = TRUE)
# if you rather bind the two matrices together by rows, use 'add_batch_record()'
lit_matrix <- add_batch_record(lit_matrix, additional_matrix)
```
#### Searching for Records
Once your matrix is set up, you might need to search for specific studies based on keywords, author names, or topics. Use `search_record()` to filter the matrix for relevant entries.
```{r searching}
# Let's find all the electronic records we've summarized so far
useless_search <- search_record(lit_matrix, where = electronic == "YES")
head(useless_search,1)
# Change format to paper record by updating electronic to "NO"
lit_matrix <- update_record(lit_matrix,electronic,where = electronic == "YES", set_to = "NO")
```
#### Exporting the Final Matrix
Once you’ve refined and categorized your literature review, you can export the matrix for further use in Excel or other tools using `export_matrix()`.
```{r exporting}
# Let's export our matrix
export_matrix(lit_matrix,"lit_matrix.txt",format = "txt")
```
This structured workflow should make managing literature reviews more efficient and streamlined.
## Project status
Actively developed, though the pace has slowed now that I'm busier with other packages and my school work. I use it almost every day so it's not going anywhere. But I have no plans to substantially enlarge or extend it before really testing it through daily use.
## Contributions
If you would like to contribute to this package, I’d love your help! Please read the guidelines for submitting a pull request.
## Code of Conduct
Please note that the `matriz` project is released with a [Contributor Code of Conduct](https://matriz.jpmonteagudo.com/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.