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 DME CLU command, type the command with the help (-h) parameter. For detailed information on each of the available DME CLU commandsuse DME CLU, 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: 

Detailed InstructionsExample
Creating an Empty Collection via the CLU

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-metadata.json /Test_Archive/PI_Lab1/Project_New

Replace the DME path (/Test_Archive/PI_Lab1/Project_New) 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_dataobject

...

$HPC_

...

DM_UTILS/templates/dataobject

...

Registering Directory Contents from Your File System via the CLU — dm_register_directory

...

Updating Collection Metadata via the CLU — dm_register_collection

...

-sync-metadata.json /Test_Archive/PI_Lab1/Project_New/test.txt $HPC_DM_UTILS/test/test.txt

Replace the DME path (/Test_Archive/PI_Lab1/Project_New/test.txt) with a DME path to which you have write access.

...

...

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

Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_download_dataobject /Test_Archive/PI_Lab1/Project_Orig/sample.txt $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 CLU

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

Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_download_collection /Test_Archive/PI_Lab1/Project_Orig $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.

...

Using DME as an Administrator

...

groupGP-CFW-DMEDOC-DEV, GP-CFW_ADMINS

...