Skip to contents

Provides Access to Versioned Schema Files

Source: R/wdds_schema_versions.R
wdds_json.Rd

Since schema versions may change during the life cycle of project, it is important that users have access to all schema versions via this package. This function allows you to quickly retrieve whichever schema version you may need.

Usage

wdds_json(version = NULL, file = NULL)

Arguments

version

Character. Version of the wdds deposit. Leave as NULL to see all versions.

file

Character. Specific file from the wdds deposit. Leave as NULL to see all files in a version.

Value

Character. Either version identifiers or file paths.

Details

This function does three things.

  1. Shows all versions of the schema in the package,

  2. Provides paths to all schema files associated with a version of the schema

  3. Provides a specific file path in a specific version of the schema.

Examples


# see which versions are in the package

wdds_json()
#> The following versions of the standard are availble in the package:
#>         -  latest
#>         -  v_1_0_0
#>         -  v_1_0_1
#>         -  v_1_0_2
#>         -  v_1_0_3
#> [1] "latest"  "v_1_0_0" "v_1_0_1" "v_1_0_2" "v_1_0_3"

# see files associated with a version

wdds_json(version = "latest")
#> /home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/latest/wdds_schema/schemas
#> /home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/latest/wdds_schema/schemas/datacite
#> /home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/latest/wdds_schema/schemas/datacite/datacite-v4.5.json
#> /home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/latest/wdds_schema/schemas/disease_data.json
#> /home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/latest/wdds_schema/schemas/project_metadata.json
#> /home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/latest/wdds_schema/wdds_schema.json

# get the file path for a specific file

wdds_json(version = "v_1_0_2",file = "schemas/disease_data.json")
#> [1] "/home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/v_1_0_2/wdds_schema/schemas/disease_data.json"