Skip to content

Commit

Permalink
url and href to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
kbroman committed Mar 10, 2019
1 parent ab756ac commit eeb6f6d
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 25 deletions.
2 changes: 1 addition & 1 deletion R/calc_errorlod.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#' markers and/or individuals).
#'
#' @param cross Object of class `"cross2"`. For details, see the
#' \href{https://kbroman.org/qtl2/assets/vignettes/developer_guide.html}{R/qtl2 developer guide}.
#' [R/qtl2 developer guide](https://kbroman.org/qtl2/assets/vignettes/developer_guide.html).
#' @param probs Genotype probabilities as calculated from [calc_genoprob()].
#' @param quiet If `FALSE`, print progress messages.
#' @param cores Number of CPU cores to use, for parallel calculations.
Expand Down
2 changes: 1 addition & 1 deletion R/calc_genoprob.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' data, with possible allowance for genotyping errors.
#'
#' @param cross Object of class `"cross2"`. For details, see the
#' \href{https://kbroman.org/qtl2/assets/vignettes/developer_guide.html}{R/qtl2 developer guide}.
#' [R/qtl2 developer guide](https://kbroman.org/qtl2/assets/vignettes/developer_guide.html).
#' @param map Genetic map of markers. May include pseudomarker
#' locations (that is, locations that are not within the marker
#' genotype data). If NULL, the genetic map in `cross` is used.
Expand Down
2 changes: 1 addition & 1 deletion R/predict_snpgeno.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' Predict SNP genotypes in a multiparent population from inferred genotypes plus founder strains' SNP alleles.
#'
#' @param cross Object of class `"cross2"`. For details, see the
#' \href{https://kbroman.org/qtl2/assets/vignettes/developer_guide.html}{R/qtl2 developer guide}.
#' [R/qtl2 developer guide](https://kbroman.org/qtl2/assets/vignettes/developer_guide.html).
#' @param geno Imputed genotypes, as a list of matrices, as from [maxmarg()].
#' @param cores Number of CPU cores to use, for parallel calculations.
#' (If `0`, use [parallel::detectCores()].)
Expand Down
10 changes: 4 additions & 6 deletions R/read_cross2.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,14 @@
#' [JSON](http://www.json.org/) format contains information
#' about basic parameters as well as the names of the series of
#' data files to be read. See the
#' \href{https://kbroman.org/qtl2/pages/sampledata.html}{sample
#' data files} and the
#' \href{https://kbroman.org/qtl2/assets/vignettes/input_files.html}{vignette
#' describing the input file format}.
#' [sample data files](https://kbroman.org/qtl2/pages/sampledata.html) and the
#' [vignette describing the input file format](https://kbroman.org/qtl2/assets/vignettes/input_files.html).
#'
#' @export
#' @keywords IO
#' @seealso [read_pheno()], [write_control_file()],
#' sample data files at \url{https://kbroman.org/qtl2/pages/sampledata.html}
#' and \url{https://github.com/rqtl/qtl2data}
#' sample data files at <https://kbroman.org/qtl2/pages/sampledata.html>
#' and <https://github.com/rqtl/qtl2data>
#'
#' @examples
#' \dontrun{
Expand Down
4 changes: 2 additions & 2 deletions R/read_pheno.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
#' @export
#' @keywords IO
#' @seealso [read_cross2()],
#' sample data files at \url{https://kbroman.org/qtl2/pages/sampledata.html}
#' and \url{https://github.com/rqtl/qtl2data}
#' sample data files at <https://kbroman.org/qtl2/pages/sampledata.html>
#' and <https://github.com/rqtl/qtl2data>
#'
#' @examples
#' \dontrun{
Expand Down
8 changes: 3 additions & 5 deletions R/write_control_file.R
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,13 @@
#' control file (in [YAML](http://www.yaml.org) format) needed
#' for the new input data file format for
#' [R/qtl2](https://kbroman.org/qtl2). See the
#' \href{https://kbroman.org/qtl2/pages/sampledata.html}{sample data
#' files} and the
#' \href{https://kbroman.org/qtl2/assets/vignettes/input_files.html}{vignette
#' describing the input file format}.
#' [sample data files](https://kbroman.org/qtl2/pages/sampledata.html) and the
#' [vignette describing the input file format](https://kbroman.org/qtl2/assets/vignettes/input_files.html).
#'
#' @export
#' @keywords utilities
#' @seealso [read_cross2()], sample data files at
#' \url{https://kbroman.org/qtl2/pages/sampledata.html}
#' <https://kbroman.org/qtl2/pages/sampledata.html>
#' @examples
#' \dontrun{
#' # Control file for the sample dataset, grav2
Expand Down
2 changes: 1 addition & 1 deletion R/zip_datafiles.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#'
#' @export
#' @keywords IO
#' @seealso [read_cross2()], sample data files at \url{https://kbroman.org/qtl2/pages/sampledata.html}
#' @seealso [read_cross2()], sample data files at <https://kbroman.org/qtl2/pages/sampledata.html>
#' @examples
#' \dontrun{
#' control_file <- "~/grav2_data/grav2.yaml"
Expand Down
6 changes: 2 additions & 4 deletions man/read_cross2.Rd

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

6 changes: 2 additions & 4 deletions man/write_control_file.Rd

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

0 comments on commit eeb6f6d

Please sign in to comment.