Skip to content

Commit

Permalink
Documentation syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
lwaldron committed May 18, 2024
1 parent 2338dcf commit d53cc84
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 25 deletions.
3 changes: 3 additions & 0 deletions R/HGNChelper-package.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#' @keywords internal
"_PACKAGE"
NULL
2 changes: 1 addition & 1 deletion R/getCurrentMaps.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' then use as an input to the \code{map} argument of \code{checkGeneSymbols}.
#' Make sure to change the default \code{species="human"} argument to \code{checkGeneSymbols}
#' if you are doing this for mouse. Use \code{getCurrentHumanMap} for HGNC human gene
#' symbols from \url{genenames.org} and \code{getCurrentMouseMap} for MGI mouse gene
#' symbols from \url{https://www.genenames.org/} and \code{getCurrentMouseMap} for MGI mouse gene
#' symbols from \url{https://www.informatics.jax.org/downloads/reports/MGI_EntrezGene.rpt}.
#' @return A \code{data.frame} that can be used for \code{map} argument of \code{checkGeneSymbols} function
#' @export getCurrentMouseMap getCurrentHumanMap
Expand Down
48 changes: 25 additions & 23 deletions man/HGNChelper-package.Rd
100755 → 100644

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

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

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

0 comments on commit d53cc84

Please sign in to comment.