Skip to content

Commit b52a98d

Browse files
committed
Fix various typos found by copilot review
1 parent f50eb5c commit b52a98d

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/user-guides/tutorial-query-on-public-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tutorial: Running a DivBase query on a public dataset
22

3-
This tutorial assumes that you have an account on DivBase and have a membership in a DivBase project with at least an EDIT role (i.e. can upload files and run queries). If this is your first time using DivBase, you may want have a look at the [Quick Start guide](quick-start.md) before trying the tutorial out.
3+
This tutorial assumes that you have an account on DivBase and have a membership in a DivBase project with at least an EDIT role (i.e. can upload files and run queries). If this is your first time using DivBase, you may want to have a look at the [Quick Start guide](quick-start.md) before trying the tutorial out.
44

55
We will use a mouse (_Mus musculus_) data set availalbe on the European Nucleotide Archive: <https://www.ebi.ac.uk/ena/browser/view/ERZ022025>. It a 5.5 Gb VCF.gz file that contains 18 samples and 66,007,044 variants.
66

docs/user-guides/vcf-dimensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ This allows the DivBase server to make quick checks against against the project
88
An updated VCF Dimensions cache for DivBase project is a prerequisite step before submitting any queries to the DivBase server.
99

1010
All query commands rely on the dimensions cache to quickly resolve samples, scaffolds, and file compatibility.
11-
Every time a new VCF files has been added added or and existic VCF version has been replaced with a new version, run:
11+
Every time a new VCF file has been added or an existing VCF version has been replaced, run:
1212

1313
```bash
1414
divbase-cli dimensions update --project <PROJECT_NAME>
1515

1616
# This will return the job ID of the submitted job. Example:
17-
# Job submitted successfully with task id: 123
17+
# Job submitted successfully with task id: 123. To check the status of your job, use the command: divbase-cli task-history id 123
1818

1919
# Job status can be viewed with e.g.
2020
divbase-cli task-history id 123

docs/user-guides/vcf-query-syntax.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ divbase-cli task-history id <JOB_ID>
1414

1515
The processing of the VCF files on the DivBase server is done with [`bcftools`](https://github.com/samtools/bcftools). DivBase will detect the VCF files in the project's data store that are needed for the query; if more than one VCF file is needed, DivBase will ensure that the files are compatible with each other according to the requirements of `bcftools` and ensure that a single results file with the subset data is returned to the user by running `bcftools merge` and `bcftools concat` on the intermediate files as needed. The result is a single VCF file that is uploaded to the projects data store and named after the job ID.
1616

17-
Users can query the VCF data in their project with or without combining it with a [sample metadata query](docs/user-guides/sidecar-metadata.md).
17+
Users can query the VCF data in their project with or without combining it with a [sample metadata query](sidecar-metadata.md).
1818

1919
Example of a VCF query that identifies the samples and VCF files to filter on in the project's datastore and then applies a subset based on genomic range:
2020

@@ -404,7 +404,7 @@ See also:
404404

405405
- [Troubleshooting](troubleshooting.md)
406406
- [VCF Dimensions](vcf-dimensions.md)
407-
- [Sample metadata query](sidecar-metadata-queries.md)
407+
- [Sample metadata query](sidecar-metadata.md)
408408

409409
## 8. Read next
410410

packages/divbase-lib/src/divbase_lib/api_schemas/queries.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ def validate_sample_selection_mode(self) -> Self:
152152
raise ValueError("Only one of tsv_filter, samples, or all_samples may be provided.")
153153
if selection_count == 0:
154154
# Backward compatibility for historical task kwargs created before all_samples option was implemented.
155-
# To ensure that task-history deserizliation does not break for existing tasks.
155+
# To ensure that task-history deserialization does not break for existing tasks.
156156
# Could be handled by a backfilling migration instead.
157157
self.all_samples = True
158158
return self

0 commit comments

Comments
 (0)