Skip to content

Commit

Permalink
reknitted documents
Browse files Browse the repository at this point in the history
also did a quick spellcheck
  • Loading branch information
smasongarrison committed May 31, 2024
1 parent 9fa0b62 commit 7ec7cf0
Show file tree
Hide file tree
Showing 18 changed files with 119 additions and 69 deletions.
2 changes: 1 addition & 1 deletion R/alignped1.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# TODO add params and example

#' First routine alignement
#' First routine alignment
#'
#' @description
#' This is the first of the four co-routines.
Expand Down
2 changes: 1 addition & 1 deletion R/alignped2.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# TODO add params and example

#' Second routine alignement
#' Second routine alignment
#'
#' @description
#' This is the second of the four co-routines.
Expand Down
2 changes: 1 addition & 1 deletion R/alignped3.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# TODO add params and example and return

#' Third routine alignement
#' Third routine alignment
#'
#' @description
#' This is the third of the four co-routines.
Expand Down
2 changes: 1 addition & 1 deletion R/besthint.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TODO add param, return, examples, keywords, seealso

#' Best hint for alignement
#' Best hint for alignment
#'
#' @description
#' When computer time is cheap, use this routine to get a "best" pedigree.
Expand Down
4 changes: 2 additions & 2 deletions R/pedigree.shrink.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
#' @examples
#' data(sample.ped)
#' pedAll <- with(sample.ped, pedigree(id, father, mother, sex,
#' affected = cbind(affected, avail), famid = ped
#' ))
#' affected = cbind(affected, avail), famid = ped))
#'
#' ped1 <- pedAll["1"]
#' ped1trim <- pedigree.shrink(ped1, maxBits = 12)
#'
Expand Down
4 changes: 2 additions & 2 deletions man/alignped1.Rd

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

4 changes: 2 additions & 2 deletions man/alignped2.Rd

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

4 changes: 2 additions & 2 deletions man/alignped3.Rd

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

46 changes: 27 additions & 19 deletions man/alignped4.Rd

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

2 changes: 1 addition & 1 deletion man/as.data.frame.pedigree.Rd

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

2 changes: 1 addition & 1 deletion man/besthint.Rd

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

24 changes: 16 additions & 8 deletions man/fixParents.Rd

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

24 changes: 24 additions & 0 deletions man/kinship2.Rd

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

7 changes: 3 additions & 4 deletions man/legendPlot.Rd

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

2 changes: 1 addition & 1 deletion man/ped2df.Rd

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

38 changes: 24 additions & 14 deletions man/pedigree.Rd

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

10 changes: 5 additions & 5 deletions man/pedigree.legend.Rd

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

9 changes: 5 additions & 4 deletions man/pedigree.shrink.Rd

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

0 comments on commit 7ec7cf0

Please sign in to comment.