listMetaGenomes: List available metagenomes on NCBI Genbank

View source: R/listMetaGenomes.R

listMetaGenomesR Documentation

List available metagenomes on NCBI Genbank

Description

List available metagenomes on NCBI genbank. NCBI genbank allows users to download entire metagenomes of several metagenome projects. This function lists all available metagenomes that can then be downloaded via getMetaGenomes.

Usage

listMetaGenomes(details = FALSE)

Arguments

details

a boolean value specifying whether only the scientific names of stored metagenomes shall be returned (details = FALSE) or all information such as "organism_name","bioproject", etc (details = TRUE).

Author(s)

Hajk-Georg Drost

See Also

getMetaGenomes, getMetaGenomeSummary

Examples

## Not run: 
# retrieve available metagenome projects at NCBI Genbank
listMetaGenomes()
# retrieve detailed information on available metagenome projects 
# at NCBI Genbank
listMetaGenomes(details = TRUE)

## End(Not run)

HajkD/biomartr documentation built on Dec. 9, 2023, 7:25 p.m.