Skip to content

Commit

Permalink
modify doc
Browse files Browse the repository at this point in the history
  • Loading branch information
super-lou committed Aug 30, 2024
1 parent 1ae31e1 commit 6ec7860
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This project was carried out for National Research Institute for Agriculture, Fo
## Installation
For latest development version
``` r
remotes::install_github('super-lou/EXstat')
remotes::install_github("super-lou/EXstat")
```


Expand Down Expand Up @@ -136,31 +136,31 @@ To do this, you need to download the [CARD archive](https://github.com/super-lou
In this way, you can carry out "analyse_1" by running:

``` r
CARD_extraction(data %>% rename(Q = X),
CARD_path = 'path/to/CARD',
CARD_dir = 'analyse_1')
CARD_extraction(data %>% rename(Q=X),
CARD_path="path/to/CARD",
CARD_dir="analyse_1")
```

Thus, you can place several CARDs in your "analyse_1" sub-directory for multiple analyses.

However, this copy/pasting action can be quite cumbersome and repetitive for large analyses. Therefore, with `CARD_management`, it is possible to automate the CARD copy/pasting from the CARD directory to an external temporary directory, like this:

``` r
CARD_management(CARD_path = "path/to/CARD",
CARD_tmp = "path/to/copy/CARD",
CARD_dir = "analyse_1",
CARD_name = c("QA", "QJXA"),
overwrite = TRUE,
verbose = TRUE)
CARD_management(CARD_path="path/to/CARD",
CARD_tmp="path/to/copy/CARD",
CARD_dir="analyse_1",
CARD_name=c("QA", "QJXA"),
overwrite=TRUE,
verbose=TRUE)
```

As a result, to run the analysis, use:

``` r
CARD_extraction(data %>% rename(Q = X),
CARD_path = "path/to/CARD",
CARD_tmp = "path/to/copy/CARD",
CARD_dir = "analyse_1")
CARD_extraction(data %>% rename(Q=X),
CARD_path="path/to/CARD",
CARD_tmp="path/to/copy/CARD",
CARD_dir="analyse_1")
```

Take a look at the [CARD](https://github.com/super-lou/CARD/?tab=readme-ov-file#documentation) repository to better understand the CARD formatting.
Expand Down

0 comments on commit 6ec7860

Please sign in to comment.