hubGenerator: hubGenerator

Description Usage Arguments Value Examples

View source: R/hubGenerator.R

Description

Generates a local folder with the basic hub structure

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
hubGenerator(
  path_local_hub,
  hub_name,
  hub_short_label,
  hub_long_label,
  email_address,
  description_url = NULL,
  assembly_database,
  gattaca_html = "http://gattaca.imppc.org/genome_browser/lplab",
  gattaca_folder_hub
)

Arguments

path_local_hub

Local folder of the hub where the files generated will be saved. A folder with the hub_name will be generated.

hub_name

Single-word name of the directory containing the track hub files. Not displayed to hub users.

hub_short_label

The short name for the track hub. Suggested maximum length is 17 characters. Displayed as the hub name on the Track Hubs page and the track group name on the browser tracks page.

hub_long_label

Longer descriptive label for the track hub. Suggested maximum length is 80 characters. Displayed in the description field on the Track Hubs page.

email_address

Email that will be provided in the hub for contact info.

description_url

URL to HTML page with a description of the hub's contents.

assembly_database

Reference genome used for alignment.

gattaca_folder_hub

Folder in the server where to save hub directory

Value

Creates a folder with the basics (hub.txt and genomes.txt) for the generation of a UCSC hub (based on gattaca server).

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
path_tracks <- path
hub_name <- 'example_hub_multiple'
path_local_hub <- file.path(path, 'hubs')
dir.create(path_local_hub)
hub_short_label <- hub_name
hub_long_label <- 'Example of ucschubgenerator using different type of files and parameters'
email_address <- 'example@email.com'
assembly_database <- 'hg38'
gattaca_folder_hub <- 'exampleHub'
hubGenerator(path_local_hub = path_local_hub,
            hub_name = hub_name,
            hub_short_label = hub_short_label,
            hub_long_label = hub_long_label,
            email_address = email_address,
            description_url = NULL,
            assembly_database = assembly_database,
            gattaca_folder_hub = gattaca_folder_hub)

msubirana/ucschubgenerator documentation built on May 10, 2020, 1:48 a.m.