GGD Commands

[Click here to return to the home page]

To see and/or search for data packages available through GGD, see: Available data packages

Important

If you use GGD, please cite the Nature Communications GGD paper

The ggd command line interface (cli) has multiple tools for data access and local management. Below you can find a short description of each tool, as well as links to specific pages about each.

Tabs for each tool are also available on the left tab bar.

Command	Description
ggd search	Search for a ggd data package
ggd predict-path	Predict the file path of a data package that has not been installed yet (Good for workflows like Snakemake)
ggd install	Install ggd data package(s)
ggd uninstall	Uninstall a ggd data package(s)
ggd list	List the installed data packages (in a specific environment)
ggd get-files	get the files for an installed ggd package
ggd pkg-info	Show a specific ggd package’s info
ggd show-env	Show the ggd specific environment variables
ggd make-recipe	Create a ggd recipe from a bash script
ggd make-meta-recipe	Create a ggd meta-recipe from a single or group of script
ggd check-recipe	Check/test a ggd recipe

Command links:

• ggd search
  • Using ggd search
  • Example
• ggd install
  • Using ggd install
  • Examples
• ggd predict-path
  • Using ggd predict-path
  • Examples
• ggd uninstall
  • Using ggd uninstall
  • Examples
• ggd list
  • Using ggd list
  • Examples
• ggd get-files
  • Using ggd get-files
  • Examples
• ggd pkg-info
  • Using ggd pkg-info
  • Examples
• ggd show-env
  • Using ggd show-env
  • Examples
• ggd make-recipe
  • Using ggd make-recipe
  • Data recipe standards
  • Examples
• ggd make-meta-recipe
  • Using ggd make-meta-recipe
  • Examples
• ggd check-recipe
  • check-recipe is used to validate a recipe created from running ggd make-recipe
  • Using ggd check-recipe
  • Example