@univ-lehavre/atlas-validate-openalex
v0.5.1
Published
CLI tools for OpenAlex bibliographic data validation and reliability
Readme
@univ-lehavre/atlas-validate-openalex
Interactive CLI for validating and assessing the reliability of OpenAlex bibliographic data. Guides a user through author search, affiliation selection, and publication curation using Effect.
Installation
pnpm add @univ-lehavre/atlas-validate-openalexUsage
pnpm -F @univ-lehavre/atlas-validate-openalex startThe CLI prompts interactively to:
- Search for an author by name
- Select matching display name variants
- Select relevant affiliations
- Curate the final publication list
Configuration
Requires a .env file:
USER_AGENT=my-app/1.0
RATE_LIMIT={"limit":1,"interval":"1 seconds"}
API_URL=https://api.openalex.org
RESULTS_PER_PAGE=25
OPENALEX_API_KEY= # optionalAPI
This package is primarily a CLI. Its internals are exported for programmatic use:
Fetch
| Export | Description |
|--------|-------------|
| searchAuthorsByName(names, config) | Search authors by name via fetch-openalex |
| searchAuthorsByORCID(orcids, config) | Search authors by ORCID |
| searchWorksByAuthorIDs(ids, config) | Fetch works by author IDs |
| searchWorksByORCID(orcid, config) | Fetch works by ORCID |
| searchWorksByDOI(dois, config) | Fetch works by DOI |
Tools
| Export | Description |
|--------|-------------|
| buildIntegrity(data) | Generates a UUID v5 hash from JSON-stable-stringified data, scoped to the context namespace |
| uniqueSorted<T>(values) | Returns a deduplicated and sorted array |
