Mercurial > repos > galaxyp > custom_pro_db_annotation_data_manager

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/COPYING	Tue May 24 11:47:26 2016 -0400
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
--- a/data_manager/customProDB_annotation.R	Thu Jan 28 18:46:50 2016 -0500
+++ b/data_manager/customProDB_annotation.R	Tue May 24 11:47:26 2016 -0400
@@ -16,6 +16,8 @@

 option_list <- list()
 option_list$dbkey <- make_option('--dbkey', type='character')
+option_list$dbsnp <- make_option('--dbsnp', type='character')
+option_list$cosmic <- make_option('--cosmic', type='logical')
 option_list$outputFile <- make_option('--outputFile', type='character')
 option_list$dbkey_description <- make_option('--dbkey_description', type='character')

@@ -24,6 +26,8 @@

 customProDB_annotation <- function(
 	dbkey = GalaxyCharacterParam(required=TRUE),
+	dbsnp_str = GalaxyCharacterParam(required=FALSE),
+	cosmic = GalaxyLogicalParam(required=FALSE),
 	dbkey_description = GalaxyCharacterParam(required=FALSE),
 	outputFile = GalaxyOutput("output","json"))
 {
@@ -37,6 +41,24 @@
         dbkey_description = dbkey
     }

+    if (length(dbsnp_str) > 0)
+    {
+        dbsnp = dbsnp_str
+    }
+    else
+    {
+        dbsnp = NULL
+    }
+
+    if (cosmic && grepl("^hg", dbkey))
+    {
+        use_cosmic = TRUE
+    }
+    else
+    {
+        use_cosmic = NULL
+    }
+
     suppressPackageStartupMessages(library(rjson))
     params = fromJSON(file=outputFile)
     target_directory = params$output_data[[1]]$extra_files_path
@@ -65,7 +87,7 @@
     download.file(ucscTableProteinFastaURL, proteinFastaFilepath, quiet=T, mode='wb')

     cat(paste("Preparing Refseq annotation files\n"))
-    customProDB::PrepareAnnotationRefseq(genome=dbkey, CDSfasta=codingFastaFilepath, pepfasta=proteinFastaFilepath, annotation_path=target_directory)
+    customProDB::PrepareAnnotationRefseq(genome=dbkey, CDSfasta=codingFastaFilepath, pepfasta=proteinFastaFilepath, annotation_path=target_directory, dbsnp=dbsnp, cosmic=use_cosmic)

     outputPath = paste(dbkey, "/customProDB", sep="")
     output = list(data_tables = list())
--- a/data_manager/customProDB_annotation.xml	Thu Jan 28 18:46:50 2016 -0500
+++ b/data_manager/customProDB_annotation.xml	Tue May 24 11:47:26 2016 -0400
@@ -3,6 +3,10 @@
     <command interpreter="Rscript --vanilla">customProDB_annotation.R
       --outputFile "${out_file}"
       --dbkey "${dbkey}"
+      --dbsnp "${dbsnp}"
+      #if $cosmic
+            --cosmic true
+      #end if
       --dbkey_description ${ dbkey.get_display_text() }
       2&gt;&amp;1
     </command>
@@ -12,6 +16,8 @@
     </stdio>
     <inputs>
         <param type="genomebuild" name="dbkey" value="" label="UCSC dbKey for reference genome" />
+        <param type="text" name="dbsnp" value="" label="dbSNP identifier currently available from UCSC" help="e.g. 'snp142'" />
+        <param type="boolean" name="cosmic" value="" label="Annotate somatic SNPs from COSMIC (human only)" />
     </inputs>
     <outputs>
         <data name="out_file" format="data_manager_json"/>
--- a/tool-data/customProDB.loc.sample	Thu Jan 28 18:46:50 2016 -0500
+++ b/tool-data/customProDB.loc.sample	Tue May 24 11:47:26 2016 -0400
@@ -1,18 +1,16 @@
 #This file lists the locations and dbkeys of all the fasta files
-#under the "genome" directory (a directory that contains a directory
-#for each build). The script extract_fasta.py will generate the file
-#all_fasta.loc. This file has the format (white space characters are
-#TAB characters):
+#under the "customProDB" directory (a subdirectory of a genome build).
+#This file has the format (white space characters are TAB characters):
 #
-#<unique_build_id>	<dbkey>		<display_name>	<file_path>
+#<unique_build_id>	<dbkey>		<display_name>	<path to annotation files>
 #
 #So, all_fasta.loc could look something like this:
 #
-#apiMel3	apiMel3	Honeybee (Apis mellifera): apiMel3		/path/to/genome/apiMel3/apiMel3.fa
-#hg19canon	hg19		Human (Homo sapiens): hg19 Canonical		/path/to/genome/hg19/hg19canon.fa
-#hg19full	hg19		Human (Homo sapiens): hg19 Full			/path/to/genome/hg19/hg19full.fa
+#apiMel3	apiMel3	Honeybee (Apis mellifera): apiMel3		/path/to/genome/apiMel3
+#hg19canon	hg19		Human (Homo sapiens): hg19 Canonical		/path/to/genome/hg19
+#hg19full	hg19		Human (Homo sapiens): hg19 Full			/path/to/genome/hg19full
 #
-#Your all_fasta.loc file should contain an entry for each individual
+#Your customProDB.loc file should contain an entry for each individual
 #fasta file. So there will be multiple fasta files for each build,
 #such as with hg19 above.
 #