Skip to content

Commit 9be59e9

Browse files
committed
typos and minor clarifications
1 parent bdeb554 commit 9be59e9

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It consists of these standards:
1313
| ----------- | ------------------------------------ | |
1414
| [Refget Sequences](sequences/README.md) | For individual sequences | :white_check_mark: v1.0 Approved in 2021 <br>:white_check_mark:&nbsp;v2.0&nbsp;Approved in 2024 |
1515
| [Refget Sequence Collections](seqcols/README.md) | For collections of sequences | :white_check_mark: v1.0 Approved in 2025 |
16-
| Refget pangenomes | For collections of sequence collections | :fontawesome-solid-gears: Currently in process |
16+
| Refget Pangenomes | For collections of sequence collections | :fontawesome-solid-gears: Currently in process |
1717

1818

1919
## What is the main purpose of the refget project?
@@ -25,7 +25,7 @@ Refget standards help to **identify**, **retrieve**, and **compare** reference s
2525
- Refget standards also specify **retrieval APIs**, providing a mechanism for retrieving a sequence or collection if you have its identifier.
2626
- Refget sequence collections also provides a programmatic approach to assessing compatibility among sequence collections.
2727

28-
For more information about use cases, see the [use cases section of the sequence collections specification](seqcols/README.md#use-cases).
28+
For more information about use cases, see the [use cases section of the Sequence Collections specification](seqcols/README.md#use-cases).
2929

3030
## How do the standards work together?
3131

docs/seqcols/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Unique identifiers, such as those provided by the NCBI Assembly database, partia
3838
- It does not address the related challenge of determining compatibility among reference genomes. Analytical results or annotations based on different references may still be integrable if certain conditions are met, but current tools and standards lack the means to formalize and simplify compatibility comparisons.
3939

4040
The [refget Sequences standard](../sequences/README.md) provides a partial solution applicable to individual sequences, such as a single chromosome.
41-
However, refget does not directly address collections of sequences, such as a linear reference genome.
42-
Building on refget, the sequence collections specification introduces foundational concepts that support diverse use cases, including:
41+
However, refget Sequences does not directly address collections of sequences, such as a linear reference genome.
42+
Building on refget Sequences, the *Sequence Collections* specification introduces foundational concepts that support diverse use cases, including:
4343

4444
- **Accessing sequences**: *As a data analyst, I want to know which sequences are in a specific collection so I can analyze them further.*
4545
- **Comparing collections**: *As a data analyst, I want to compare the sequence collections used in two separate analyses to assess the compatibility of their resulting data.*
@@ -53,7 +53,7 @@ Building on refget, the sequence collections specification introduces foundation
5353

5454
## Architectural decision record
5555

56-
For a chronological record of decisions related to this specification, see the [Architectural decision record](../decision_record.md).
56+
For a chronological record of decisions related to this specification, see the [Architectural Decision Record (ADR)](../decision_record.md).
5757

5858
## Definitions of key terms
5959

@@ -288,7 +288,7 @@ Zjx9_tD2o-1yKB6RR2v2g3W9c5ufydUc
288288

289289
##### Level 1
290290

291-
What you'd get when you look up the digest with **1 database lookup**. We sometimes refer to this as the "array digests" or "attribute digests", because it is made up a digest for each attribute in the sequence collection. Example:
291+
What you'd get when you look up the digest with **1 database lookup**. We sometimes refer to this as the "attribute digests", because it is made up a digest for each attribute in the sequence collection. Example:
292292

293293
```json
294294
{
@@ -300,7 +300,7 @@ What you'd get when you look up the digest with **1 database lookup**. We someti
300300

301301
##### Level 2
302302

303-
What you'd get with **2 database lookups**. This is the most common representation, and hence, it the level of the *canonical seqcol representation*. Example:
303+
What you'd get with **2 database lookups**. This is the most common representation, and hence, it is the level of the *canonical seqcol representation*. Example:
304304

305305
```json
306306
{

0 commit comments

Comments
 (0)