Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Polkas authored Jan 16, 2025
1 parent 425710b commit db9f598
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 14 deletions.
11 changes: 4 additions & 7 deletions man/Rcpp_corrData-class.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,19 @@
\description{
This C++ class could be used to build a corrData object by invoking \code{new(corrData,...)} function.
}
\section{Extends}{
Class \code{"\linkS4class{C++Object}"}, directly.

All reference classes extend and inherit methods from \code{"\linkS4class{envRefClass}"}.

}
\references{
See the documentation for RcppArmadillo and Rcpp for more details of how this class was built.
\url{https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf}
}

\note{
This is only frame for building C++ object which could be used to implement certain methods.
Check the vignette for more details of implementing methods.
}

%% ~Make other sections like Warning with \section{Warning }{....} ~
Vigniette:
\url{https://CRAN.R-project.org/package=miceFast}
}

\examples{
#showClass("Rcpp_corrData")
Expand Down
7 changes: 1 addition & 6 deletions man/Rcpp_miceFast-class.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,10 @@
\description{
This C++ class could be used to build a miceFast objects by invoking \code{new(miceFast)} function.
}
\section{Extends}{
Class \code{"\linkS4class{C++Object}"}, directly.

All reference classes extend and inherit methods from \code{"\linkS4class{envRefClass}"}.

}
\references{
See the documentation for RcppArmadillo and Rcpp for more details of how this class was built.
\url{https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf}
}

\note{
Expand All @@ -26,7 +22,6 @@ Vigniette:
\url{https://CRAN.R-project.org/package=miceFast}
}

%% ~Make other sections like Warning with \section{Warning }{....} ~

\examples{
#showClass("Rcpp_miceFast")
Expand Down
2 changes: 1 addition & 1 deletion man/VIF.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit db9f598

Please sign in to comment.