NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be undergoing maintenance Monday, July 22nd between 1700 ET and 1800 ET and will be unavailable during this period.
Please ensure all work is saved before said time.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 4

changes.mady.by.user Unknown User (endlecm)

Saved on

compared with

New Version 5

changes.mady.by.user Unknown User (endlecm)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

LoadLgXML

Loads a vocabulary file, provided in LexGrid canonical xml format.
Options:

  • -in,-input <uri> URI specifying location of the source file.
  • -v, -validate <level> Perform validation of the candidate resource without loading data.  If specified, the '-a' and '-t' options are ignored.  Supported levels of validation include:
    • 0 = Verify document is well-formed
    • 1 = Verify document is valid
  • -a,-activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.

  • -t, -tag <tagID> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.
    Load Example:

     

    LoadLgXML -in "file:///path/to/file.xml" -nf -a


    Validation Example:

     

    LoadLgXML -in "file:///path/to/file.xml" -v 0
LoadMedDRALoads a file specified in the Medical Dictionary for Regulatory Activities (MedDRA) format.

Options:
  •    -in,--input <uri> URI or path specifying location of the source file
  •    -mf,--manifest <uri> URI or path specifying location of the manifest file
  •    -v, --validate <int> Perform validation of the candidate  resource without loading data.  If specified, the '-a' and '-t' options are ignored.  Supported levels of validation include:0 = Verify document is valid
  •    -a, --activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.
  •    -t, --tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.
  •    -cui  Uri to MRCONSO.RRF from the NCI Metathesaurus allows loading of CUI's  for a given term. (Slows load time considerably)


Load Example:

 

LoadMedDRA -in "file:///path/to/file.asc" -a

 

Validation Example:

 

LoadMedDRA -in "file:///path/to/file.asc" -v 0

 

Load CUI Example:

LoadMetaData

Loads optional XML-based metadata to be associated with an existing coding scheme.

  • -u,-urn <name> URN uniquely identifying the code system.
  • -v,-version <id> Version identifier.
  • -in,-input <uri> URI or path specifying location of the XML file.
  • -v,-validate <int> Perform validation of the input file without loading data.  If specified, the '-f', and '-o' options are ignored.  Supported levels of validation include:  0 = Verify document is valid
  • -o, -overwrite If specified, existing metadata for the code system will be erased. Otherwise, new metadata will be appended to existing metadata (if present).
  • -f,-force Force overwrite (no confirmation).

    Note

     

    If the URN and version values are unspecified, a list of available coding schemes will be presented for user selection.


    Examples:

     

    LoadMetadata -in "file:///path/to/file.xml" -o

     

     

    LoadMetadata -in "file:///path/to/file.xml"

LoadMIFVocabulary

Loads from an the HL7 Vocabulary mif file.

 Options:
  •    -in,--input <uri> URI or path specifying location of the source file.
  •    -a, --activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.
  •    -t, --tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.


Load Example:

 

LoadMIFVocabulary -in "file:///path/to/file.xml" -a
LoadMrMap

Loads mappings file(s), provided in UMLS RRF format. Specifically MRMAP.RRF and MRSAT.RRF.
Options:

LoadNCIHistory

Imports NCI History data to the LexEVS repository.
Options:

  • -in,-input <uri> URI specifying location of the history file
  • -vf,-versionFile <uri> URI specifying location of the file containing version identifiers for the history to be loaded.
  • -v, -validate <level>Perform validation of the candidate resource without loading data.  If specified, the '-r' option is ignored.  Supported levels of validation include:
    • 0 = Verify top 10 lines are correct format
    • 1 = Verify correct format for the entire file

  • -r, -replace If not specified, the provided history file will be added into the current history database; otherwise the current database will be replaced by the new content.
    Load Example:


    Validation Example:

     

    LoadNCIHistory -in "file:///path/to/history.file" -v 0

     

    Versions File Format Information:

     

    releaseDate | isLatest | releaseAgency | releaseId | releaseOrder | entityDescription

     

    Sample record:

     

    28-NOV-05 | false | [http://nci.nih.gov] | 05.10e | 26 | Editing of NCI Thesaurus 05.10e was completed on October 31, 2005.  Version 05.10e was October's fifth build in our development cycle.

LoadOBO

Loads a file specified in the Open Biomedical Ontologies (OBO) format.
Options:

  • -in,-input <uri> URI or path specifying location of the source file
  • -v,-validate <int> Perform validation of the candidate resource without loading data. If specified, the '-nf', -a' and '-t' options are ignored. Supported levels of validation include:
    • 0 = Verify document is valid
  • -nf,-noFail If specified, indicates that processing should not stop for recoverable errors
  • -a, -activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated

  • -t, -tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.
    Examples:

     

    LoadOBO -in "file:///path/to/file.obo" -nf -a

     

     

    LoadOBO -in "file:///path/to/file.obo" -v 0

LoadOWL

Loads an OWL file.

Note

 

Load of the NCI Thesaurus should be performed via the LoadNCIThesOWL counterpart, since it will allow more precise handling of NCI semantics.

Options:

  • -in,-input <uri> URI or path specifying location of the source file
  • -mf,--manifest <uri> URI or path specifying location of the manifest file
  • -v, -validate <int> Perform validation of the candidate resource without loading data.  If specified, the '-a' and '-t' options are ignored.  Supported levels of validation include:
    • 0 = Verify document is well-formed
    • 1 = Verify document is valid
  • -a, -activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated

  • -t, -tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.
    Example:

     

    LoadOWL -in "file:///path/to/somefile.owl" -a

     

     

    LoadOWL -in "file:///path/to/somefile.owl" -v 0
LoadOWL2

 Loads an OWL file. You can provide a manifest file to configure coding scheme# meta data.

 Options:

  •    -in,--input <uri> URI or path specifying location of the source file
  •    -mf,--manifest <uri> URI or path specifying location of the manifest file
  •    -lp,--loaderPrefs<uri> URI or path specifying location of the loader preference file
  •    -v, --validate <int> Perform validation of the candidate resource without loading data.  If specified, the '-a' and '-t' options are ignored.  Supported levels of validation include:
  •          0 = Verify document is well-formed
  •          1 = Verify document is valid
  •    -a, --activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.
  •    -t, --tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.


 Load Example:

 

LoadOWL2 -in "file:///path/to/somefile.owl" -a

 

 

LoadOWL2 -in "file:///path/to/somefile.owl" -v 0
LoadResolvedValueSetDefinition

Loads Value Set Definition content, provided in LexGrid canonical xml format.


 Options:
   -u, The valueset definition URI to use
   -l, The list of coding schemes to revolve against. The format is codingschemeName::version
   -csVersionTag, The tag to use for resolving coding scheme
       
Load Example:

 

LoadResolvedValueSetDefinition -u \"Automobiles:valuesetDefinitionURI\" -l \"Automobiles::version1, GM::version2\" -csVersionTag \"production\" ""

 


LoadText

Loads a file in LexGrid Text format.

Options:

   -in,--input <uri> URI or path specifying location of the source file

   -d, --delimiter <character> defaults to tab the character used to delimit pair or triple components and the nesting.

   -mf,--manifest <uri> URI or path specifying location of the manifest file.

   -v, --validate <int> Perform validation of the candidate resource without loading data.  If specified, the '-a' and '-t' options are ignored.  Supported levels of validation include:

      0 = Verify document is valid

   -a, --activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.

   -t, --tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.

 

Load Example:

 

LoadText -in "file:///path/to/file.txt" -a
LoadText -in "file:///path/to/file.txt" -v 0
LoadUMLSHistory

Loads UMLS History


 Options:

   -in,--input <uri> URI or path specifying location of the source file

   -v, --validate <int> Perform validation of the candidate resource without loading data.  If specified, the '-a' and '-t' options are ignored.  Supported levels of validation include:

      0 = Verify document is valid

   -a, --activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.

   -r, --replace Replace exisiting file.

   -t, --tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.


Load Example:

 

LoadUMLSHistory -in "file:///path/to/META.folder" -r
 LoadUMLSHistory -in "file:///path/to/META.folder" -v 0
LoadUMLSSemnet.sh

Loads the UMLS Semantic Network, provided as a collection of files in a single directory.  The following files are expected to be provided from the National Library of Medicine (NLM) distribution:
   - LICENSE.txt (text from distribution terms and conditions)
   - SRFIL.txt (File Description)
   - SRFIL.txt (Field Description)
   - SRDEF.txt (Basic information about the Semantic Types and Relations)
   - SRSTR.txt (Structure of the Network)
   - SRSTRE1.txt (Fully inherited set of Relations (UIs))
   - SRSTRE2.txt (Fully inherited set of Relations (Names))
   - SU.txt (Unit Record)
These files can be downloaded from the NLM web site at http://semanticnetwork.nlm.nih.gov/Download/index.html.

Options:

   -in,--input <uri> URI or path of the directory containing the NLM files

   -v, --validate <int> Perform validation of the candidate resource without loading data.  If specified, the '--a' and '-t' options are ignored.  Supported levels of validation include:

        0 = Verify the existence of each required file

   -a, --activate ActivateScheme on successful load; if unspecified the vocabulary is loaded but not activated.

   -t, --tag <id> An optional tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.

   -il,--InheritanceLevel <int> If specified, indicates the extent of inherited relationships to import.  

        0 = none; 1 = all; 2 = all except is_a (default).

        All direct relationships are imported, regardless of option.

Load Example:

 

LoadUMLSSemnet -in "file:///path/to/directory/" -a
LoadUMLSSemnet -in "file:///path/to/directory/" -v 0

Special Batch Loading Functions

...