NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added 2700 limitation as requested by Udit & Yuri.

To view usage information for any use DME CLU command, type the command with the help (-h) parameter. For detailed information on each of the available DME CLU commands, refer to the following pagesprerequisites:

The character limit for each metadata value is 2700.

The following table provides examples for some of the most commonly-used DME CLU commands: 

dm_register_dataobject /cygdrive/c/Users/JaneDoe/my-metadata.json /Example

Replace the DME path (/Test_Archive/PI_Lab1/Project_New

/Data.txt /cygdrive/c/Users/JaneDoe/data.txtdm_register_dataobject /cygdrive/c/Users/JaneDoe/my-metadata.json /Example

_Archive/PI_Lab1/

Project1

Project_New/

data

test.txt) with a DME path to which you have write access.

Detailed InstructionsExample
Detailed InstructionsCommandExample
Generating a DME API Authentication Token via the CLUdm_generate_token
Clipboard
AllowLineWraptrue

dm_generate_token

Creating an Empty Collection via the CLUdm_register_collection

The following command creates a Project_New collection within the PI_Lab1 collection and applies to that new collection the metadata in the collection-metadata.json file: 

Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_register_collection $HPC_DM_UTILS/templates/collection

my

-

collection

metadata.json /

Example

Test_Archive/PI_Lab1/Project_New

Registering a Data File via the CLUdm_register_dataobject
Clipboard
AllowLineWraptrue
Updating Collection Metadata via the CLUdm_register_collection

) with a DME path to which you have write access. The JSON file must contain metadata for the new collection, Project_New. If the parent collection, PI_Lab1, does not already exist, then the JSON file must also contain metadata for that collection.

Registering a Data File via the CLU

The following command registers the test.txt file from a test folder to the Project_New collection in DME: 

Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_register

_collection my-collection

_dataobject $HPC_DM_UTILS/templates/dataobject-sync-metadata.json /

Example

Test_Archive/PI_Lab1/

Project1
Updating Data File Metadata via the CLUdm_register_dataobject

Project_New/test.txt $HPC_DM_UTILS/test/test.txt

Replace the DME path (/Test

Clipboard
AllowLineWraptrue
Downloading One or More Files via the CLU

The following command downloads a sample.txt file from the Project_Orig collection in DME to a test folder:

Panel
borderColorsilver
borderStylesolid
dm_download_dataobject
Clipboard
AllowLineWraptrue

dm_download_dataobject /

Example

Test_Archive/PI_Lab1/Project_Orig/sample.txt

/cygdrive/c/Users/JaneDoe

$HPC_DM_UTILS/test

Replace the DME path (/Test_Archive/PI_Lab1/Project_Orig/sample.txt) with a DME path to which you have read access.

Downloading One or More Collections via the CLUdm_download_collection

The following command downloads the Project_Orig collection in DME to a test folder:

Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_download_collection /

Example

Test_Archive/PI_Lab1/Project_Orig

/cygdrive/c/Users/JaneDoe

$HPC_DM_UTILS/test

Replace the DME path (/Test_Archive/PI_Lab1/Project_Orig) with a DME path to which you have read access. The command creates a Project_Orig folder.