Skip to content

Commit

Permalink
added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
haasek committed Mar 8, 2018
1 parent 4903df6 commit 3592bb0
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion ASCAT/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: ASCAT
Type: Package
Title: Allele-Specific Copy Number Analysis of Tumours
Version: 2.5.2
Version: 2.5.1
Date: 2017-07-10
Authors@R: c(person("Peter", "Van Loo", role=c("aut","cre"), email="[email protected]"),
person("Gro", "Nielsen", role="ctb"),
Expand Down
10 changes: 10 additions & 0 deletions ASCAT/R/ascat.R
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ ascat.loadData = function(Tumor_LogR_file, Tumor_BAF_file, Germline_LogR_file =
#' @title ascat.plotRawData
#' @description Plots SNP array data
#' @param ASCATobj an ASCAT object (e.g. data structure from ascat.loadData)
#' @param img.dir directory in which figures will be written
#' @param img.prefix prefix for figure names
#'
#' @return Produces png files showing the logR and BAF values for tumour and germline samples
#'
Expand Down Expand Up @@ -315,6 +317,8 @@ ascat.GCcorrect = function(ASCATobj, GCcontentfile = NULL) {
#' @param selectsamples a vector containing the sample number(s) to PCF. Default = all
#' @param ascat.gg germline genotypes (NULL if germline data is available)
#' @param penalty penalty of introducing an additional ASPCF breakpoint (expert parameter, don't adapt unless you know what you're doing)
#' @param out.dir directory in which output files will be written
#' @param out.prefix prefix for output file names
#'
#' @return output: ascat data structure containing:\cr
#' 1. Tumor_LogR data matrix\cr
Expand Down Expand Up @@ -550,6 +554,8 @@ ascat.aspcf = function(ASCATobj, selectsamples = 1:length(ASCATobj$samples), asc
#' @description plots the SNP array data before and after segmentation
#'
#' @param ASCATobj an ASCAT object (e.g. from ascat.aspcf)
#' @param img.dir directory in which figures will be written
#' @param img.prefix prefix for figure names
#'
#' @return png files showing raw and segmented tumour logR and BAF
#'
Expand Down Expand Up @@ -610,6 +616,8 @@ ascat.plotSegmentedData = function(ASCATobj, img.dir=".", img.prefix="") {
#' @param circos Optional file to output the non-rounded values in Circos track format. Default=NA
#' @param rho_manual optional argument to override ASCAT optimization and supply rho parameter (not recommended)
#' @param psi_manual optional argument to override ASCAT optimization and supply psi parameter (not recommended)
#' @param img.dir directory in which figures will be written
#' @param img.prefix prefix for figure names
#' @details Note: for copy number only probes, nA contains the copy number value and nB = 0.
#' @return an ASCAT output object, containing:\cr
#' 1. nA: copy number of the A allele\cr
Expand Down Expand Up @@ -2196,6 +2204,8 @@ psi <- function(x,z){
#' is available
#' @param ASCATobj an ASCAT object
#' @param platform used array platform
#' @param img.dir directory in which figures will be written
#' @param img.prefix prefix for figure names
#' @details Currently possible values for platform:\cr
#' AffySNP6 (default)\cr
#' Custom10k\cr
Expand Down
Binary file removed ASCAT_2.5.2.tar.gz
Binary file not shown.

0 comments on commit 3592bb0

Please sign in to comment.