Skip to content

Commit fb3d111

Browse files
authored
Create README.md
0 parents  commit fb3d111

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
2+
---
3+
4+
### `README.md`**CSV/SQL Merger**
5+
6+
```markdown
7+
# CSV/SQL Merger for Data Preprocessing
8+
9+
This Shiny application allows users to merge two tabular data sources—such as CSV or TXT files, optionally with SQL dump support—into a single, harmonized data frame. It is designed for pre-processing fragmented lab data before importing into systems like [eLabFTW](https://www.elabftw.net/).
10+
11+
## Screenshot
12+
13+
![Placeholder for screenshot](screenshot_sql_merger.png)
14+
15+
## Features
16+
17+
- Upload two files in `.csv` or `.txt` format
18+
- Extract column headers from `CREATE TABLE` SQL dump files (if headers are missing)
19+
- Configure key columns for merging
20+
- Join types supported:
21+
- Inner Join
22+
- Outer Join
23+
- Left Join
24+
- Right Join
25+
- Automatic renaming of columns to avoid duplication
26+
- Preview of input files and final merged result
27+
- Export to `.csv` or `.xlsx` format with custom filename
28+
29+
## Intended Use
30+
31+
This tool is useful for consolidating legacy inventory files from multiple departments or sources. It reduces the manual effort of combining and cleaning data prior to ELN import and supports transparent, structured data workflows.
32+
33+
## Installation and Usage
34+
35+
1. Install [R](https://cran.r-project.org/) and [RStudio](https://posit.co/)
36+
2. Install dependencies:
37+
38+
```r
39+
install.packages(c("shiny", "readr", "writexl", "stringr", "DT", "shinyjs"))
40+
```
41+
42+
3. Launch the application:
43+
44+
```r
45+
shiny::runApp("path/to/csv-sql-merger")
46+
```
47+
48+
## Dependencies
49+
R ≥ 4.0
50+
Packages:
51+
- shiny
52+
- readr
53+
- writexl
54+
- stringr
55+
- DT
56+
- shinyjs
57+
58+
## File Structure
59+
- app.R – Main application code
60+
- screenshot_sql_merger.png – Placeholder for interface screenshot
61+
- readme.html – Optional help documentation

0 commit comments

Comments
 (0)