✅ Check

Perform checks on associated research activity data to ensure consistency, readability, and easy analysis.

Example Use

# Check a specific research activity index
acorn check path/to/project/index.json

# Check all research activity data in a directory
acorn check path/to/project/

Check Categories

• 🏛️ Schema Validation: Ensure that all data files conform to the expected schema
• ✨ Prose Quality: Analyze written content for standards such as grammar, spelling, and word counts
• 👓 Readability: Evaluate readability of written content using established metrics¹
• 🔗 Link Integrity: Verify all hyperlinks within the content are valid and reachable
• 📊 Data Consistency: Check for dataset consistency and completeness
• 🚦 Convention Adherence: Ensure compliance with naming conventions and organization-specific standards

Customization Options

The check command supports several flags and options to customize its behavior (e.g., skipping certain checks, disabling certain behaviors, etc.)

Include --exit-on-first-error to stop execution upon encountering the first error.

Bypass verifying the checksum of downloaded artifacts with --skip-verify-checksum²

Skip Checks

• --skip schema : Skip schema validation checks
• --skip prose : Skip prose quality checks
• --skip readability : Skip readability checks
• --skip schema,prose : Skip both schema validation and prose quality checks (this works for any combination of categories)
• --disable-website-checks : Disable all website-related checks (link integrity, etc.)

Note

--disable-website-checks is redundant when acorn --offline is used for commands that need to be run in offline environments.

Configure Readability

Readability can be configured for desired metric and level by passing options directly to the command line or via a .env file. Command line options override .env settings.

• --readability-metric <METRIC> : Specify which readability metric to use
• Set READABILITY_METRIC in your .env file to choose the readability metric. Default metric is fkgl (Flesch-Kincaid Grade Level).
• Set MAX_ALLOWED_FKGL in your .env file to define the maximum acceptable FKGL score. Each metric has its own corresponding maximum score variable (e.g., MAX_ALLOWED_ARI for Automated Readability Index).

Example .env file

Configure ACORN to use the Coleman-Liau Index (CLI) readability metric with a maximum allowed score of 14.0 (default value is 12.0):

READABILITY_METRIC=cli
MAX_ALLOWED_CLI=14.0

1. See the readability module documentation for a full list of available readability metrics. ↩

2. ⚠️ Skipping checksum verification may expose you to security risks. Use this option with caution. ↩