Typo in the documentation re fold_changes in simulate_experiment

[ning-y]

polyester/R/simulate_experiment.R

Lines 135 to 149 in 29263d1

	#' @param fold_changes Matrix specifying multiplicative fold changes
	#' between groups. There is no default, so you must provide this argument.
	#' In real data sets, lowly-expressed transcripts often show high fold
	#' changes between groups, so this can be kept in mind when setting
	#' \code{fold_changes} and \code{reads_per_transcript}. This argument must
	#' have the same number of columns as there are groups as
	#' specified by \code{num_reps}, and must have the same number of rows as
	#' there are transcripts in \code{fasta}. A fold change of X in matrix entry
	#' i,j means that for replicate j, the baseline mean number of reads
	#' (reads_per_transcript[i]) will be multiplied by X. Note that the
	#' multiplication happens before the negative binomial value
	#' (for the number of reads that *actually will* be
	#' drawn from transcript i, for replicate j) is drawn. This argument is
	#' ignored if \code{length(num_reps)} is 1 (meaning you only have 1 group in
	#' your simulation).

A fold change of X in matrix entry i,j means that for replicate j, the baseline mean number of reads (reads_per_transcript[i]) will be multiplied by X.

should probably be

A fold change of X in matrix entry i,j means that for group j, the baseline mean number of reads (reads_per_transcript[i]) will be multiplied by X.