Description Usage Arguments Details Value Examples
This function updates project's file metadata. You can also use this call
to change filenames if you supply the name
argument.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | file_meta_update(
auth_token = NULL,
project_id = NULL,
file_id = NULL,
name = NULL,
file_type = c("text", "binary", "fasta", "csfasta", "fastq", "qual", "xsq", "sff",
"bam", "bam_index", "illumina_export", "vcf", "sam", "bed", "archive", "juncs",
"gtf", "gff", "enlis_genome"),
qual_scale = c("sanger", "illumina13", "illumina15", "illumina18", "solexa"),
seq_tech = c("454", "Helicos", "Illumina", "Solid", "IonTorrent"),
sample = NULL,
library = NULL,
platform_unit = NULL,
paired_end = NULL,
...
)
|
auth_token |
auth token |
project_id |
ID of a project you want to access. |
file_id |
ID of a file you want to access. |
name |
File name. |
file_type |
File type. This metadata parameter is mandatory for each file. |
qual_scale |
Quality scale encoding. For FASTQ files, you must
either specify the quality score encoding sch which contains the
FASTQ quality scale detector wrapper. In that case, you can
specify the quality score encoding scheme by setting
|
seq_tech |
Sequencing technology. The |
sample |
Sample ID. You can use the |
library |
Library. You can set the library for the read using the
|
platform_unit |
Platform unit. You can set the platform unit
(e.g. lane for Illumina, or slide for SOLiD) using the |
paired_end |
Paired end. With paired-end reads, this parameter indicates if the read file is left end (1) or right end (2). For SOLiD CSFASTA files, paired end files 1 and 2 correspond to R3 and F3 files, respectively. |
... |
parameters passed to sbgapi function |
For more information about file metadata, please check the File Metadata Documentation: https://developer.sbgenomics.com/platform/metadata.
parsed list of the returned json
1 2 3 4 5 6 7 | token = '420b4672ebfc43bab48dc0d18a32fb6f'
req = file_meta_update(token,
project_id = '1c1d06d2-5862-48f6-b595-e0099b20937e',
file_id = '530854e2e4b036506b803c7e',
name = 'c.elegans_chr2_test.fastq',
file_type = 'fastq', qual_scale = 'illumina13',
seq_tech = 'Illumina')
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.