NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Deleted based on 1/19 discussion.
Excerpt
hiddentrue

dm_download_collection

If your user account has the Read , Write, or Own permission level on a on a collection, the following command allows you to download that collection and all subcollections to your file local system:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_download_collection

[optional

parameters]

<source-path>

<destination-path>

The following table describes each parameter:

ParameterDescription
[-h]If you want to print a usage (help) message for this command, specify this option.
[-t <num-threads>]

If you want to use this parameter, contact NCIDataVault@mail.nih.gov for guidance.

Show If
groupGP-CFW-DMEDOC-DEV, GP-CFW_ADMINS
Panel
borderColorsilver
borderStylesolid
titleVisible to Internal Users Only

If you want to process the files more efficiently with a smoother download, consider specifying the number of threads (from 1 to 32) that you want the system to use while downloading files from DME. Your network and the server directly impact the way the system downloads files. You can set the number of threads

so the system has enough memory while processing massive files

to concurrently download multiple files in the specified collection.

  • For faster processing of your command, use more threads.
  • For faster processing of the system as a whole, use fewer threads.

The default is one thread.

<source-path>A path within DME. Specify the path for the DME collection you want to download.
<destination-path>A path in your file local system. Specify where you want the system to create the downloaded file or files. If the destination folder structure you specify does not already exist, DME creates it. 

The following example downloads the contents of the Project_Orig collection in DME to a JaneDoe folder in Windows.   (The command does not create creates a Project_Orig folder.)

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_download_collection

/Example_Archive/PI_Lab1/Project_Orig

/

cygdrive/c/Users

NCI/JaneDoe