Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: April Shen <[email protected]>
  • Loading branch information
Dona094 and apriltuesday authored Sep 17, 2024
1 parent 28fcb83 commit c1a17e1
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ There are currently three ways to install and run the tool :
### 1. Conda

The most straightforward way to install eva-sub-cli and its dependencies is through conda.
For instance, the following commands installs eva-sub-cli in a new environment called `eva`, activates the environment, and prints
For instance, the following commands install eva-sub-cli in a new environment called `eva`, activate the environment, and print
the help message:
```bash
conda create -n eva -c conda-forge -c bioconda eva-sub-cli
Expand All @@ -24,7 +24,7 @@ eva-sub-cli.py --help

Docker provides an easy way to run eva-sub-cli without installing dependencies separately.
This method requires just Python 3.8+ and [Docker](https://docs.docker.com/engine/install/) to be installed.
Once it is setup, you can either clone the git repository, or download the newest tagged release from [here](https://github.com/EBIvariation/eva-sub-cli/tags):
Once it is set up, you can either clone the git repository, or download the newest tagged release from [here](https://github.com/EBIvariation/eva-sub-cli/tags):
```bash
git clone [email protected]:EBIvariation/eva-sub-cli.git
Expand Down Expand Up @@ -59,7 +59,7 @@ Install each of these and ensure they are included in your PATH. Then, either cl
## Getting started with the eva-sub-cli tool


The [README file ](Getting_Started_with_eva_sub_cli.md) serves as an introductory guide for users of the eva-sub-cli tool. It includes instructions on how to prepare your data and metadata, ensuring that users are equipped with the necessary information to successfully submit variant data. This guide is essential for new users, offering practical advice and tips for a smooth onboarding experience with the eva-sub-cli tool.
The ["Getting Started" guide](Getting_Started_with_eva_sub_cli.md) serves as an introduction for users of the eva-sub-cli tool. It includes instructions on how to prepare your data and metadata, ensuring that users are equipped with the necessary information to successfully submit variant data. This guide is essential for new users, offering practical advice and tips for a smooth onboarding experience with the eva-sub-cli tool.

## eva-sub-cli tool: Options and parameters guide

Expand Down Expand Up @@ -87,15 +87,14 @@ It should be populated following the instruction provided within the template

### The metadata JSON

The metadata can also be provided via a JSON file which should conform to the schema located at
`eva_sub_cli/etc/eva_schema.json`
The metadata can also be provided via a JSON file, which should conform to the schema located [here](eva_sub_cli/etc/eva_schema.json).


## Execution

### Validate only

To validate and not submit run the following command
To validate and not submit, run the following command:

```shell
eva-sub-cli.py --metadata_xlsx metadata_spreadsheet.xlsx --submission_dir submission_dir --tasks VALIDATE
Expand Down Expand Up @@ -123,7 +122,7 @@ eva-sub-cli.py --metadata_xlsx metadata_spreadsheet.xlsx \

### Submit only

All submission must have been validated. You cannot run the submission without validation. Once validated, execute the following command
All submissions must have been validated. You cannot run the submission without validation. Once validated, execute the following command:

```shell
eva-sub-cli.py --metadata_xlsx metadata_spreadsheet.xlsx --submission_dir submission_dir
Expand Down

0 comments on commit c1a17e1

Please sign in to comment.