[Rqda-commits] r46 - in pkg: . man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Dec 15 16:09:22 CET 2008
Author: wincent
Date: 2008-12-15 16:09:22 +0100 (Mon, 15 Dec 2008)
New Revision: 46
Added:
pkg/man/GetCodingTable.rd
pkg/man/GetFileId.rd
pkg/man/SearchFiles.rd
pkg/man/SummaryCoding.rd
Modified:
pkg/DESCRIPTION
pkg/TODO
Log:
Modified: pkg/DESCRIPTION
===================================================================
--- pkg/DESCRIPTION 2008-12-15 14:42:46 UTC (rev 45)
+++ pkg/DESCRIPTION 2008-12-15 15:09:22 UTC (rev 46)
@@ -1,7 +1,7 @@
Package: RQDA
Type: Package
Title: Qualitative Data Analysis
-Version: 0.1.5-43
+Version: 0.1.5-45
Date: 2008-12-12
Author: HUANG Ronggui
Maintainer: HUANG Ronggui <ronggui.huang at gmail.com>
Modified: pkg/TODO
===================================================================
--- pkg/TODO 2008-12-15 14:42:46 UTC (rev 45)
+++ pkg/TODO 2008-12-15 15:09:22 UTC (rev 46)
@@ -1,7 +1,5 @@
*Todo
-documentation
-
Merge *rqda from different coders
inter-coder reliability
Added: pkg/man/GetCodingTable.rd
===================================================================
--- pkg/man/GetCodingTable.rd (rev 0)
+++ pkg/man/GetCodingTable.rd 2008-12-15 15:09:22 UTC (rev 46)
@@ -0,0 +1,25 @@
+\name{GetCodingTable}
+\alias{GetCodingTable}
+\title{ Get the information of codings }
+\description{
+Get the information of codings.
+}
+\usage{
+GetCodingTable()
+}
+%- maybe also 'usage' for other objects documented here.
+\details{
+Codings are stored in the coding table of *.rqda file. The coding table contains necessary information, but not informative to end-users. For example, it has id of code list and file list, but not the name of them, which are stored in freecode table and source table respectively. \code{GetCodingTable} joins information from the three tables, and returns more informative data. See value section on the the returned components.
+}
+\value{
+A data frame:
+ \item{cid }{Code id}
+ \item{fid }{File id}
+ \item{codename }{Code name, in accordance with cid}
+ \item{filename }{File name, in accordance with fid}
+ \item{CodingLength }{The number of characters in the coding}
+}
+\author{ HUANG Ronggui}
+%\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
+%\examples{}
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Added: pkg/man/GetFileId.rd
===================================================================
--- pkg/man/GetFileId.rd (rev 0)
+++ pkg/man/GetFileId.rd 2008-12-15 15:09:22 UTC (rev 46)
@@ -0,0 +1,35 @@
+\name{GetFileId}
+\alias{GetFileId}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{ Get the id of files list }
+\description{
+ Get the id of files list.
+}
+\usage{
+GetFileId(condition = c("unconditional", "case", "filecategory"), type = c("all", "coded", "uncoded"))
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{condition}{Any one of "unconditional", "case" or "filecategory".}
+ \item{type}{Any one of "all", "coded" or "uncoded".}
+}
+\details{
+ The imported files are stored in a data base table (called source) in the *.rqda file. Every file in the source table has a unique id. Besides, a: every file can be assigned to a case or file category. b: they may be either coded or uncoded. \code{GetFileId} return the id of files which fit the combined criterion of a and b. The argument "condition" describe the criterion of a, and "type" describes that of b. When "condition" is "case" or "filecategory", \code{GetFileId} returns the id of files associated with the selected case or file category, which means you have to select a case or file category; otherwise the result is NULL.
+}
+\value{
+Normally, it is a numeric vector of file id. If condition is "case" or "filecategory" but no case or file category is selected, it retuns NULL.
+}
+\author{ HUANG Ronggui}
+%\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
+\examples{
+\dontrun{
+GetFileId() ## Id of all files
+GetFileId("unconditional","coded") ## id of all coded files.
+GetFileId("case","uncoded") ## id of uncoded files for the selected case.
+GetFileId("filecategory","all") ## id of all files in the selected file category.
+}
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+%\keyword{ ~kwd1 }
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Added: pkg/man/SearchFiles.rd
===================================================================
--- pkg/man/SearchFiles.rd (rev 0)
+++ pkg/man/SearchFiles.rd 2008-12-15 15:09:22 UTC (rev 46)
@@ -0,0 +1,39 @@
+\name{SearchFiles}
+\alias{SearchFiles}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{ Search files}
+\description{
+ Search files according to the pattern.
+}
+\usage{
+SearchFiles(pattern, content = FALSE, Widget = NULL, is.UTF8 = FALSE)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{pattern}{ The criterion of search, see examples section for examples.}
+ \item{content}{ When it is TRUE, the content of files fitting the pattern will be returned as well.}
+ \item{Widget}{ The name of a gtable widget. If it is not NULL, the file names fitting the pattern will pushed to that gtable widget using \code{svalue} method. One useful value is .rqda$fnames_rqda, so the file names will be pushed to the Files Tab of RQDA. }
+ \item{is.UTF8}{ If the coding of pattern is UTF-8. If you are not sure, always use FLASE.}
+}
+\details{
+This function use select statment of sql to search files (from source database table). The pattern is the WHERE clause (without the keyword WHERE). For more information, please refer to the website of SQLite syntax. All data in *.rqda use UTF-8 encoding, so the encoding of pattern matters. It will be converted to UTF-8 if it is not (is.UTF8=FALSE).
+}
+\value{
+A data frame with variables:
+ \item{id }{The file id.}
+ \item{name }{The file name.}
+ \item{file }{The file content. Only return when content is TRUE.}
+}
+\references{ \url{http://www.sqlite.org/lang_expr.html} }
+\author{ HUANG Ronggui }
+\seealso{\code{\link[gWidgets]{gtable}}, \code{\link[utils]{localeToCharset}}}
+\examples{
+\dontrun{
+SearchFiles("file like '%keyword%'") ## search for files who contain the word of "keyword"
+SearchFiles("file like 'keyword%'") ## search for files whose conent begin with the word of "keyword"
+SearchFiles("name like '%keyword'") ## search for files whose name end with the word of "keyword"
+SearchFiles("name like '%keyword one' and file like '%keyword tow%' ") ## combined conidtions
+}
+}
+%\keyword{ ~kwd1 }
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
Added: pkg/man/SummaryCoding.rd
===================================================================
--- pkg/man/SummaryCoding.rd (rev 0)
+++ pkg/man/SummaryCoding.rd 2008-12-15 15:09:22 UTC (rev 46)
@@ -0,0 +1,39 @@
+\name{SummaryCoding}
+\alias{SummaryCoding}
+\alias{print.SummaryCoding}
+\title{Summary of coding}
+\description{
+Give a summary of coding of current project.
+}
+\usage{
+SummaryCoding(byFile = FALSE, ...)
+\method{print}{SummaryCoding}
+}
+\arguments{
+ \item{byFile}{When it is FALSE, return the summary of current project.
+When it is TRUE, return the summary of coding for each coded file.}
+% \item{x}{An object returned by \code{SummaryCoding}.}
+ \item{\dots}{Other possible arguments.}
+}
+%\details{
+% ~~ If necessary, more details than the description above ~~
+%}
+\value{
+ A list:
+ \item{NumOfCoding}{Number of coding for each code.}
+ \item{AvgLength}{Average number of characters in codings for
+each code.}
+ \item{NumOfFile}{Number of files coded for each code}.
+ \item{CodingOfFile}{Number of codings for each file.NULL is
+byFile is FALSE.}
+}
+\author{ HUANG Ronggui}
+\seealso{\code{\link{GetFileId}} and \code{\link{GetCodingTable}}}
+\examples{
+\dontrun{
+SummaryCoding()
+SummaryCoding(FALSE)
+}
+}
+%\keyword{ ~kwd1 }
+%\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
More information about the Rqda-commits
mailing list