Commit9e82eb8

committed

Addwrite_xlsx() function (closes#45)

1 parentdccccd0 commit9e82eb8Copy full SHA for 9e82eb8

File tree

+69

-1

lines changed

+69

-1

lines changed

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,8 @@ Imports:`
`44`	`44`	`plyr,`
`45`	`45`	`testthat,`
`46`	`46`	`utils,`
`47`		`- progress`
	`47`	`+ progress,`
	`48`	`+ writexl`
`48`	`49`	`Suggests:`
`49`	`50`	`httptest,`
`50`	`51`	`spelling,`
`@@ -85,5 +86,6 @@ Collate:`
`85`	`86`	`'tests.R'`
`86`	`87`	`'utils-pipe.R'`
`87`	`88`	`'utils.R'`
	`89`	`+ 'write_xlsx.R'`
`88`	`90`	`VignetteBuilder: knitr`
`89`	`91`	`biocViews: ThirdPartyClient, BiomedicalInformatics, GenomeWideAssociation, SNP`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ export(union)`
`31`	`31`	`export(variant_to_association)`
`32`	`32`	`export(variant_to_study)`
`33`	`33`	`export(variant_to_trait)`
	`34`	`+export(write_xlsx)`
`34`	`35`	`exportClasses(associations)`
`35`	`36`	`exportClasses(studies)`
`36`	`37`	`exportClasses(traits)`

Lines changed: 28 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,28 @@`
	`1`	`+#' Export a GWAS Catalog object to xlsx`
	`2`	`+#'`
	`3`	`+#' This function exports a GWAS Catalog object to Microsoft Excel xlsx file.`
	`4`	`+#' Each table (slot) is saved in its own sheet.`
	`5`	`+#'`
	`6`	`+#' @param x A \linkS4class{studies}, \linkS4class{associations},`
	`7`	`+#' \linkS4class{variants} or \linkS4class{traits} object.`
	`8`	`+#' @param file A file name to write to.`
	`9`	`+#'`
	`10`	`+#' @return Although this function is run for its side effect of writing an xlsx`
	`11`	`+#' file, the path to the exported file is returned.`
	`12`	`+#'`
	`13`	`+#' @examples`
	`14`	`+#' # Initial setup`
	`15`	`+#' .old_wd <- setwd(tempdir())`
	`16`	`+#'`
	`17`	+#' # Save an `associations` object, e.g. `associations_ex01`, to xlsx.
	`18`	`+#' write_xlsx(associations_ex01, "associations.xlsx")`
	`19`	`+#'`
	`20`	`+#' # Cleanup`
	`21`	`+#' unlink("associations.xlsx")`
	`22`	`+#' setwd(.old_wd)`
	`23`	`+#'`
	`24`	`+#' @export`
	`25`	+write_xlsx<-function(x,file= stop('`file` must be specified')) {
	`26`	`+lst<- s4_to_list(x)`
	`27`	`+writexl::write_xlsx(lst,path=file)`
	`28`	`+}`

Lines changed: 3 additions & 0 deletions

Lines changed: 34 additions & 0 deletions

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

Comments

(0)