[Seqinr-commits] r1716 - pkg/man

[noreply at r-forge.r-project.org]

Author: lobry
Date: 2009-11-18 20:41:33 +0100 (Wed, 18 Nov 2009)
New Revision: 1716

Modified:
   pkg/man/write.fasta.Rd
Log:
doc more explicit

Modified: pkg/man/write.fasta.Rd
===================================================================
--- pkg/man/write.fasta.Rd	2009-11-16 17:29:42 UTC (rev 1715)
+++ pkg/man/write.fasta.Rd	2009-11-18 19:41:33 UTC (rev 1716)
@@ -1,16 +1,15 @@
 \name{write.fasta}
 \alias{write.fasta}
-\title{ Write file in fasta format }
+\title{ Write sequence(s) into a file in fasta format }
 \description{
-  Writes sequences to a file in FASTA format.
+  Writes one or more sequences into a file in FASTA format.
 }
 
-\usage{write.fasta(sequences, names, nbchar = 60, file.out, open = "w")}
+\usage{write.fasta(sequences, names, file.out, open = "w", nbchar = 60)}
 
 \arguments{
-  \item{sequences}{ A DNA or protein sequence (i.e. a
-    character vector) or a list of  sequences (i.e. a
-    list of character vectors). }
+  \item{sequences}{ A DNA or protein sequence (in the form of a
+    vector of single characters) or a list of such sequences. }
   \item{names}{ The name(s) of the sequences. }
   \item{nbchar}{ The number of characters per line (default: 60) }
   \item{file.out}{ The name of the output file. }
@@ -18,7 +17,7 @@
   a new file, use "a" to append at the end of an already existing file.}
 }
 \value{
- NULL
+ none.
 }
 \references{
   \code{citation("seqinr")}