Mentions légales du service

Skip to content
Snippets Groups Projects
Commit b40e2cc0 authored by EL KARCHI Jad's avatar EL KARCHI Jad
Browse files

Edit README.md

parent a911a285
No related branches found
No related tags found
No related merge requests found
# **R package : rlabkey-cli v1.0.0**
This R package provides services for **data management** and **optimized communication** with the **Labkey Server**, making it easier for data managers to handle file transfers and dataset management tasks. It acts as middleware, simplifying interactions with the **Rlabkey API** and ensuring an efficient and reliable pipeline for **ETL** (Extract, Transform, Load) processes.
This R package (rlabkeyCLI) provides services for **data management** and **optimized communication** with the **Labkey Server**, making it easier for data managers to handle file transfers and dataset management tasks. It acts as middleware, simplifying interactions with the **Rlabkey API** and ensuring an efficient and reliable pipeline for **ETL** (Extract, Transform, Load) processes.
With services such as **fetch**, **push**, and **status**, this package minimizes the manual work required to download files or directories from the Labkey server, upload cleaned datasets, and check the system status. It provides a fail-safe mechanism to streamline your data management workflows, especially in cloud-based environments.
......@@ -31,13 +31,13 @@ The `fetch` function allows you to retrieve files or directories from the Labkey
## Fetch the entire project directory
``` R
fetch(projectName, remoteFilePath = NULL)
rlabkeyCLI::fetch(projectName, remoteFilePath = NULL)
```
## Fetch a sepcific file from the project directory
``` R
fetch(projectName, remoteFilePath = "data/file.csv")
rlabkeyCLI::fetch(projectName, remoteFilePath = "data/file.csv")
```
### 2. **Pushing Data**
......@@ -47,13 +47,13 @@ The `push` function is used to upload datasets or files to the Labkey server aft
## Push a dataset to Labkey
``` R
push(projectName, filePath, targetName, dirPath = NULL, isAssay = FALSE, isDataset = TRUE)
rlabkeyCLI::push(projectName, filePath, targetName, dirPath = NULL, isAssay = FALSE, isDataset = TRUE)
```
## Push an assay to Labkey (Not supported on v1.0.0)
``` R
push(projectName, filePath, targetName, dirPath = NULL, isAssay = TRUE, isDataset = FALSE)
rlabkeyCLI::push(projectName, filePath, targetName, dirPath = NULL, isAssay = TRUE, isDataset = FALSE)
```
### 3. **Checking Server Status**
......@@ -63,7 +63,7 @@ The `status` function checks and returns the connection status to the Labkey ser
## Check the status of the labkey server connection
``` R
status()
rlabkeyCLI::status()
```
## **Planned Features**
......
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