diff --git a/.gitignore b/.gitignore index 234f028..0fc4bfa 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,4 @@ .Rhistory .RData .Ruserdata -docs + diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..1dd3fe0 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,136 @@ + + + + + + + +Page not found (404) • mammalcol + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+
+ + +Content not found. Please use links in the navbar. + +
+ + + +
+ + + + +
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 0000000..30e3161 --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,103 @@ + +License • mammalcol + + +
+
+ + + +
+
+ + +
YEAR: 2024
+COPYRIGHT HOLDER: Sahir Bhatnagar
+
+ +
+ + + +
+ + + +
+ + + + + + + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html new file mode 100644 index 0000000..e166839 --- /dev/null +++ b/docs/LICENSE.html @@ -0,0 +1,107 @@ + +MIT License • mammalcol + + +
+
+ + + +
+
+ + +
+ +

Copyright (c) 2024 Sahir Bhatnagar

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+ +
+ + + +
+ + + +
+ + + + + + + + diff --git a/docs/apple-touch-icon-120x120.png b/docs/apple-touch-icon-120x120.png new file mode 100644 index 0000000..aa23353 Binary files /dev/null and b/docs/apple-touch-icon-120x120.png differ diff --git a/docs/apple-touch-icon-152x152.png b/docs/apple-touch-icon-152x152.png new file mode 100644 index 0000000..9a1430a Binary files /dev/null and b/docs/apple-touch-icon-152x152.png differ diff --git a/docs/apple-touch-icon-180x180.png b/docs/apple-touch-icon-180x180.png new file mode 100644 index 0000000..a6b0a85 Binary files /dev/null and b/docs/apple-touch-icon-180x180.png differ diff --git a/docs/apple-touch-icon-60x60.png b/docs/apple-touch-icon-60x60.png new file mode 100644 index 0000000..b17b870 Binary files /dev/null and b/docs/apple-touch-icon-60x60.png differ diff --git a/docs/apple-touch-icon-76x76.png b/docs/apple-touch-icon-76x76.png new file mode 100644 index 0000000..f59d452 Binary files /dev/null and b/docs/apple-touch-icon-76x76.png differ diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png new file mode 100644 index 0000000..a6b0a85 Binary files /dev/null and b/docs/apple-touch-icon.png differ diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 0000000..c963a09 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,118 @@ + +Authors and Citation • mammalcol + + +
+
+ + + +
+
+
+ + + +
  • +

    Diego J. Lizcano. Author, maintainer. +

    +
  • +
+
+
+

Citation

+ Source: inst/CITATION +
+
+ + +

Lizcano, DJ. (2024). mammalcol: Access to the List of Mammal Species of Colombia. R package version 0.0.2

+
@Manual{,
+  title = {mammalcol: Access to the List of Mammal Species of Colombia},
+  author = {Diego J. Lizcano},
+  note = {R package version 0.0.2},
+  year = {2024},
+}
+ +
+ +
+ + + +
+ + + + + + + + diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css new file mode 100644 index 0000000..5a85941 --- /dev/null +++ b/docs/bootstrap-toc.css @@ -0,0 +1,60 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ + +/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */ + +/* All levels of nav */ +nav[data-toggle='toc'] .nav > li > a { + display: block; + padding: 4px 20px; + font-size: 13px; + font-weight: 500; + color: #767676; +} +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 19px; + color: #563d7c; + text-decoration: none; + background-color: transparent; + border-left: 1px solid #563d7c; +} +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 18px; + font-weight: bold; + color: #563d7c; + background-color: transparent; + border-left: 2px solid #563d7c; +} + +/* Nav: second level (shown on .active) */ +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} +nav[data-toggle='toc'] .nav .nav > li > a { + padding-top: 1px; + padding-bottom: 1px; + padding-left: 30px; + font-size: 12px; + font-weight: normal; +} +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 29px; +} +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 28px; + font-weight: 500; +} + +/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */ +nav[data-toggle='toc'] .nav > .active > ul { + display: block; +} diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js new file mode 100644 index 0000000..1cdd573 --- /dev/null +++ b/docs/bootstrap-toc.js @@ -0,0 +1,159 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ +(function() { + 'use strict'; + + window.Toc = { + helpers: { + // return all matching elements in the set, or their descendants + findOrFilter: function($el, selector) { + // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/ + // http://stackoverflow.com/a/12731439/358804 + var $descendants = $el.find(selector); + return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])'); + }, + + generateUniqueIdBase: function(el) { + var text = $(el).text(); + var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-'); + return anchor || el.tagName.toLowerCase(); + }, + + generateUniqueId: function(el) { + var anchorBase = this.generateUniqueIdBase(el); + for (var i = 0; ; i++) { + var anchor = anchorBase; + if (i > 0) { + // add suffix + anchor += '-' + i; + } + // check if ID already exists + if (!document.getElementById(anchor)) { + return anchor; + } + } + }, + + generateAnchor: function(el) { + if (el.id) { + return el.id; + } else { + var anchor = this.generateUniqueId(el); + el.id = anchor; + return anchor; + } + }, + + createNavList: function() { + return $(''); + }, + + createChildNavList: function($parent) { + var $childList = this.createNavList(); + $parent.append($childList); + return $childList; + }, + + generateNavEl: function(anchor, text) { + var $a = $(''); + $a.attr('href', '#' + anchor); + $a.text(text); + var $li = $('
  • '); + $li.append($a); + return $li; + }, + + generateNavItem: function(headingEl) { + var anchor = this.generateAnchor(headingEl); + var $heading = $(headingEl); + var text = $heading.data('toc-text') || $heading.text(); + return this.generateNavEl(anchor, text); + }, + + // Find the first heading level (`

    `, then `

    `, etc.) that has more than one element. Defaults to 1 (for `

    `). + getTopLevel: function($scope) { + for (var i = 1; i <= 6; i++) { + var $headings = this.findOrFilter($scope, 'h' + i); + if ($headings.length > 1) { + return i; + } + } + + return 1; + }, + + // returns the elements for the top level, and the next below it + getHeadings: function($scope, topLevel) { + var topSelector = 'h' + topLevel; + + var secondaryLevel = topLevel + 1; + var secondarySelector = 'h' + secondaryLevel; + + return this.findOrFilter($scope, topSelector + ',' + secondarySelector); + }, + + getNavLevel: function(el) { + return parseInt(el.tagName.charAt(1), 10); + }, + + populateNav: function($topContext, topLevel, $headings) { + var $context = $topContext; + var $prevNav; + + var helpers = this; + $headings.each(function(i, el) { + var $newNav = helpers.generateNavItem(el); + var navLevel = helpers.getNavLevel(el); + + // determine the proper $context + if (navLevel === topLevel) { + // use top level + $context = $topContext; + } else if ($prevNav && $context === $topContext) { + // create a new level of the tree and switch to it + $context = helpers.createChildNavList($prevNav); + } // else use the current $context + + $context.append($newNav); + + $prevNav = $newNav; + }); + }, + + parseOps: function(arg) { + var opts; + if (arg.jquery) { + opts = { + $nav: arg + }; + } else { + opts = arg; + } + opts.$scope = opts.$scope || $(document.body); + return opts; + } + }, + + // accepts a jQuery object, or an options object + init: function(opts) { + opts = this.helpers.parseOps(opts); + + // ensure that the data attribute is in place for styling + opts.$nav.attr('data-toggle', 'toc'); + + var $topContext = this.helpers.createChildNavList(opts.$nav); + var topLevel = this.helpers.getTopLevel(opts.$scope); + var $headings = this.helpers.getHeadings(opts.$scope, topLevel); + this.helpers.populateNav($topContext, topLevel, $headings); + } + }; + + $(function() { + $('nav[data-toggle="toc"]').each(function(i, el) { + var $nav = $(el); + Toc.init($nav); + }); + }); +})(); diff --git a/docs/docsearch.css b/docs/docsearch.css new file mode 100644 index 0000000..e5f1fe1 --- /dev/null +++ b/docs/docsearch.css @@ -0,0 +1,148 @@ +/* Docsearch -------------------------------------------------------------- */ +/* + Source: https://github.com/algolia/docsearch/ + License: MIT +*/ + +.algolia-autocomplete { + display: block; + -webkit-box-flex: 1; + -ms-flex: 1; + flex: 1 +} + +.algolia-autocomplete .ds-dropdown-menu { + width: 100%; + min-width: none; + max-width: none; + padding: .75rem 0; + background-color: #fff; + background-clip: padding-box; + border: 1px solid rgba(0, 0, 0, .1); + box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175); +} + +@media (min-width:768px) { + .algolia-autocomplete .ds-dropdown-menu { + width: 175% + } +} + +.algolia-autocomplete .ds-dropdown-menu::before { + display: none +} + +.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] { + padding: 0; + background-color: rgb(255,255,255); + border: 0; + max-height: 80vh; +} + +.algolia-autocomplete .ds-dropdown-menu .ds-suggestions { + margin-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion { + padding: 0; + overflow: visible +} + +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + padding: .125rem 1rem; + margin-top: 0; + font-size: 1.3em; + font-weight: 500; + color: #00008B; + border-bottom: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--wrapper { + float: none; + padding-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column { + float: none; + width: auto; + padding: 0; + text-align: left +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content { + float: none; + width: auto; + padding: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content::before { + display: none +} + +.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header { + padding-top: .75rem; + margin-top: .75rem; + border-top: 1px solid rgba(0, 0, 0, .1) +} + +.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column { + display: block; + padding: .1rem 1rem; + margin-bottom: 0.1; + font-size: 1.0em; + font-weight: 400 + /* display: none */ +} + +.algolia-autocomplete .algolia-docsearch-suggestion--title { + display: block; + padding: .25rem 1rem; + margin-bottom: 0; + font-size: 0.9em; + font-weight: 400 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--text { + padding: 0 1rem .5rem; + margin-top: -.25rem; + font-size: 0.8em; + font-weight: 400; + line-height: 1.25 +} + +.algolia-autocomplete .algolia-docsearch-footer { + width: 110px; + height: 20px; + z-index: 3; + margin-top: 10.66667px; + float: right; + font-size: 0; + line-height: 0; +} + +.algolia-autocomplete .algolia-docsearch-footer--logo { + background-image: url("data:image/svg+xml;utf8,"); + background-repeat: no-repeat; + background-position: 50%; + background-size: 100%; + overflow: hidden; + text-indent: -9000px; + width: 100%; + height: 100%; + display: block; + transform: translate(-8px); +} + +.algolia-autocomplete .algolia-docsearch-suggestion--highlight { + color: #FF8C00; + background: rgba(232, 189, 54, 0.1) +} + + +.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight { + box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5) +} + +.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content { + background-color: rgba(192, 192, 192, .15) +} diff --git a/docs/docsearch.js b/docs/docsearch.js new file mode 100644 index 0000000..b35504c --- /dev/null +++ b/docs/docsearch.js @@ -0,0 +1,85 @@ +$(function() { + + // register a handler to move the focus to the search bar + // upon pressing shift + "/" (i.e. "?") + $(document).on('keydown', function(e) { + if (e.shiftKey && e.keyCode == 191) { + e.preventDefault(); + $("#search-input").focus(); + } + }); + + $(document).ready(function() { + // do keyword highlighting + /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */ + var mark = function() { + + var referrer = document.URL ; + var paramKey = "q" ; + + if (referrer.indexOf("?") !== -1) { + var qs = referrer.substr(referrer.indexOf('?') + 1); + var qs_noanchor = qs.split('#')[0]; + var qsa = qs_noanchor.split('&'); + var keyword = ""; + + for (var i = 0; i < qsa.length; i++) { + var currentParam = qsa[i].split('='); + + if (currentParam.length !== 2) { + continue; + } + + if (currentParam[0] == paramKey) { + keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20")); + } + } + + if (keyword !== "") { + $(".contents").unmark({ + done: function() { + $(".contents").mark(keyword); + } + }); + } + } + }; + + mark(); + }); +}); + +/* Search term highlighting ------------------------------*/ + +function matchedWords(hit) { + var words = []; + + var hierarchy = hit._highlightResult.hierarchy; + // loop to fetch from lvl0, lvl1, etc. + for (var idx in hierarchy) { + words = words.concat(hierarchy[idx].matchedWords); + } + + var content = hit._highlightResult.content; + if (content) { + words = words.concat(content.matchedWords); + } + + // return unique words + var words_uniq = [...new Set(words)]; + return words_uniq; +} + +function updateHitURL(hit) { + + var words = matchedWords(hit); + var url = ""; + + if (hit.anchor) { + url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor; + } else { + url = hit.url + '?q=' + escape(words.join(" ")); + } + + return url; +} diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png new file mode 100644 index 0000000..a5ad475 Binary files /dev/null and b/docs/favicon-16x16.png differ diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png new file mode 100644 index 0000000..d219071 Binary files /dev/null and b/docs/favicon-32x32.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..c6b96ec Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..a0fbf8b --- /dev/null +++ b/docs/index.html @@ -0,0 +1,357 @@ + + + + + + + +Access to the List of Mammals Species of Colombia • mammalcol + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    +
    +
    + + + +

    The goal of mammalcol is to allow easy access to the List of Mammal Species of Colombia.

    +
    +

    Installation +

    +

    You can install the development version of mammalcol from GitHub with:

    +
    +# install.packages("devtools")
    +devtools::install_github("dlizcano/mammalcol")
    +
    +
    +

    Example +

    +
    +

    Search database +

    +

    This is a basic example which shows you how to search mammal names in Colombia using a vector of mammal names.

    +
    +# define a vector with species to search for
    +splist <- c("Tapirus bairdii", "Tapirus pinchaque", "Tapirus terrestris",
    +           "Tapirus terrestris",  "Pudu mephistophiles", "Tapirus bairdii")
    +
    +# search in database
    +search_mammalcol(splist)
    +#> The following names are repeated in the 'splist': Tapirus bairdii, Tapirus terrestris
    +#>        name_submitted  kingdom   phylum    class          order    family
    +#> 1     Tapirus bairdii Animalia Chordata Mammalia Perissodactyla Tapiridae
    +#> 2   Tapirus pinchaque Animalia Chordata Mammalia Perissodactyla Tapiridae
    +#> 3  Tapirus terrestris Animalia Chordata Mammalia Perissodactyla Tapiridae
    +#> 4 Pudu mephistophiles Animalia Chordata Mammalia   Artiodactyla  Cervidae
    +#>     genus specificEpithet taxonRank scientificNameAuthorship
    +#> 1 Tapirus         bairdii   Especie             (Gill, 1865)
    +#> 2 Tapirus       pinchaque   Especie           (Roulin, 1829)
    +#> 3 Tapirus      terrestris   Especie         (Linnaeus, 1758)
    +#> 4    Pudu  mephistophiles   Especie        (de Winton, 1896)
    +#>               taxonRemarks
    +#> 1    Elevación (m): 0-1000
    +#> 2 Elevación (m): 1400-4000
    +#> 3    Elevación (m): 0-2400
    +#> 4 Elevación (m): 3000-3500
    +#>                                                                                                                                                                                                                                                           bibliographicCitation
    +#> 1                                                              HERSHKOVITZ P. 1954. Mammals of northern Colombia. Preliminary report No. 7: Tapirs (genus Tapirus), with a systematic review of American species. Proceedings of the United States National Museum 103:465-496.
    +#> 2                                                              ARIAS-ALZATE A, CC DOWNER, C DELGADO-V y J SÁNCHEZ-LONDOÑO. 2010. Un registro de tapir de montaña (Tapirus pinchaque) en el norte de la Cordillera Occidental de Colombia. Mastozoología Neotropical 17:111-116.
    +#> 3 ARIAS-ALZATE A, JA PALACIO VIEIRA y J MUÑOZ-DURAN. 2009. Nuevos registros de distribución y oferta de hábitat de la danta colombiana (Tapirus terrestris colombianus) en las tierras bajas del norte de la Cordillera Central (Colombia). Mastozoología Neotropical 16:19-25.
    +#> 4                                                                                                                                        ALBERICO M, A CADENA, JI HERNÁNDEZ-CAMACHO y Y MUÑOZ-SABA. 2000b. Mamíferos (Synapsida: Theria) de Colombia. Biota Colombiana 1:43-75.
    +#>   inMDD                                 Col_redlist
    +#> 1     1 EN A2cd+ B1ab (i,ii,iii)+ B2ab (i, ii, iii)
    +#> 2     1                                     EN A4cd
    +#> 3     1                                     VU A4cd
    +#> 4     1       EN A2cd B1ab (i; ii; iii; iv; v) \r\n
    +#>                                                                                                                                                                           distribution
    +#> 1                                                                                                                                                          Antioquia | Chocó | Córdoba
    +#> 2                                              Antioquia | Cauca | Cundinamarca | Huila | Meta | Nariño | Quindío | Risaralda | Tolima | Valle del Cauca | Caldas | Caquetá | Putumayo
    +#> 3 Antioquia | Amazonas | Arauca | Caquetá | Cauca | Cesar | Córdoba | Guainia | La Guajira | Meta | Magdalena | Vaupés | Vichada | Guaviare | Casanare | Norte de Santander | Putumayo
    +#> 4                                                                                                              Cauca | Huila | Nariño | Risaralda | Quindío | Tolima | Valle del Cauca
    +#>                                                         source endemic
    +#> 1 Proceedings of the United States National Museum 103:465-496      No
    +#> 2                         Mastozoología Neotropical 17:111-116      No
    +#> 3                           Mastozoología Neotropical 16:19-25      No
    +#> 4                                     Biota Colombiana 1:43-75      No
    +#>             english_name Distance
    +#> 1 Central American Tapir       12
    +#> 2         Mountain Tapir       14
    +#> 3          Lowland Tapir       16
    +#> 4          Northern Pudu       17
    +

    mammalcol has the ability to correct minor typos and lower case in the genus.

    +
    +# vector with species names and intentional typos
    +splist <- c("Tapiru terrestre", "pudu mephistophiles", "tapirus bairdii")
    +
    +# search in database
    +search_mammalcol(splist)
    +#>        name_submitted  kingdom   phylum    class          order    family
    +#> 1    Tapiru terrestre Animalia Chordata Mammalia Perissodactyla Tapiridae
    +#> 2 Pudu mephistophiles Animalia Chordata Mammalia   Artiodactyla  Cervidae
    +#> 3     Tapirus bairdii Animalia Chordata Mammalia Perissodactyla Tapiridae
    +#>     genus specificEpithet taxonRank scientificNameAuthorship
    +#> 1 Tapirus      terrestris   Especie         (Linnaeus, 1758)
    +#> 2    Pudu  mephistophiles   Especie        (de Winton, 1896)
    +#> 3 Tapirus         bairdii   Especie             (Gill, 1865)
    +#>               taxonRemarks
    +#> 1    Elevación (m): 0-2400
    +#> 2 Elevación (m): 3000-3500
    +#> 3    Elevación (m): 0-1000
    +#>                                                                                                                                                                                                                                                           bibliographicCitation
    +#> 1 ARIAS-ALZATE A, JA PALACIO VIEIRA y J MUÑOZ-DURAN. 2009. Nuevos registros de distribución y oferta de hábitat de la danta colombiana (Tapirus terrestris colombianus) en las tierras bajas del norte de la Cordillera Central (Colombia). Mastozoología Neotropical 16:19-25.
    +#> 2                                                                                                                                        ALBERICO M, A CADENA, JI HERNÁNDEZ-CAMACHO y Y MUÑOZ-SABA. 2000b. Mamíferos (Synapsida: Theria) de Colombia. Biota Colombiana 1:43-75.
    +#> 3                                                              HERSHKOVITZ P. 1954. Mammals of northern Colombia. Preliminary report No. 7: Tapirs (genus Tapirus), with a systematic review of American species. Proceedings of the United States National Museum 103:465-496.
    +#>   inMDD                                 Col_redlist
    +#> 1     1                                     VU A4cd
    +#> 2     1       EN A2cd B1ab (i; ii; iii; iv; v) \r\n
    +#> 3     1 EN A2cd+ B1ab (i,ii,iii)+ B2ab (i, ii, iii)
    +#>                                                                                                                                                                           distribution
    +#> 1 Antioquia | Amazonas | Arauca | Caquetá | Cauca | Cesar | Córdoba | Guainia | La Guajira | Meta | Magdalena | Vaupés | Vichada | Guaviare | Casanare | Norte de Santander | Putumayo
    +#> 2                                                                                                              Cauca | Huila | Nariño | Risaralda | Quindío | Tolima | Valle del Cauca
    +#> 3                                                                                                                                                          Antioquia | Chocó | Córdoba
    +#>                                                         source endemic
    +#> 1                           Mastozoología Neotropical 16:19-25      No
    +#> 2                                     Biota Colombiana 1:43-75      No
    +#> 3 Proceedings of the United States National Museum 103:465-496      No
    +#>             english_name Distance
    +#> 1          Lowland Tapir       15
    +#> 2          Northern Pudu       17
    +#> 3 Central American Tapir       12
    +
    +
    +

    Produce a map +

    +

    The function mammalmap produces basic a map of distribution at the “Departamento” level for a single species.

    +
    +# write a species name in the function to map it
    +mammalmap("Tapirus pinchaque")
    +

    +
    +
    +

    See the full taxon table +

    +
    +
    +head(taxon)
    +#>             scientificName  kingdom   phylum    class        order   family
    +#> 1       Passalites murelia Animalia Chordata Mammalia Artiodactyla Cervidae
    +#> 2            Mazama rufina Animalia Chordata Mammalia Artiodactyla Cervidae
    +#> 3 Passalites sanctaemartae Animalia Chordata Mammalia Artiodactyla Cervidae
    +#> 4            Mazama temama Animalia Chordata Mammalia Artiodactyla Cervidae
    +#> 5            Mazama zamora Animalia Chordata Mammalia Artiodactyla Cervidae
    +#> 6             Mazama zetta Animalia Chordata Mammalia Artiodactyla Cervidae
    +#>        genus specificEpithet taxonRank scientificNameAuthorship
    +#> 1 Passalites         murelia   Especie        J. A. Allen, 1915
    +#> 2     Mazama          rufina   Especie         (Pucheran, 1851)
    +#> 3 Passalites   sanctaemartae   Especie      (J. A. Allen, 1915)
    +#> 4     Mazama          temama   Especie             (Kerr, 1792)
    +#> 5     Mazama          zamora   Especie        J. A. Allen, 1915
    +#> 6     Mazama           zetta   Especie             Thomas, 1913
    +#>               taxonRemarks
    +#> 1     Elevación (m): 0-900
    +#> 2 Elevación (m): 1500-4000
    +#> 3     Elevación (m): 0-900
    +#> 4      Elevación (m): 0-68
    +#> 5  Elevación (m): 600-1200
    +#> 6 Elevación (m): 1600-1950
    +#>                                                                                                                                                                    bibliographicCitation
    +#> 1 ALLEN JA. 1916. List of mammals collected in Colombia by the American Museum of Natural History expeditions, 1910-1915. Bulletin of the American Museum of Natural History 35:191-238.
    +#> 2                                                 ALBERICO M, A CADENA, JI HERNÁNDEZ-CAMACHO y Y MUÑOZ-SABA. 2000b. Mamíferos (Synapsida: Theria) de Colombia. Biota Colombiana 1:43-75.
    +#> 3 ALLEN JA. 1916. List of mammals collected in Colombia by the American Museum of Natural History expeditions, 1910-1915. Bulletin of the American Museum of Natural History 35:191-238.
    +#> 4  GROVES C y P GRUBB. 1987. Relationships of living deer. Pp. 21-59, en: Biology and management of the Cervidae (CM Wemmer, ed.). Smithsonian Institution Press, Washington, D.C., USA.
    +#> 5 ALLEN JA. 1916. List of mammals collected in Colombia by the American Museum of Natural History expeditions, 1910-1915. Bulletin of the American Museum of Natural History 35:191-238.
    +#> 6 ALLEN JA. 1916. List of mammals collected in Colombia by the American Museum of Natural History expeditions, 1910-1915. Bulletin of the American Museum of Natural History 35:191-238.
    +#>   inMDD   Col_redlist
    +#> 1     0          <NA>
    +#> 2     1 VU A2 cde\r\n
    +#> 3     0          <NA>
    +#> 4     1            DD
    +#> 5     0            DD
    +#> 6     0            DD
    +#>                                                                                                                                                              distribution
    +#> 1                                                                                 Amazonas | Caquetá | Cauca | Meta | Vaupés | Vichada | Nariño | Putumayo | Cundinamarca
    +#> 2 Antioquia | Boyacá | Caldas | Cauca | Cesar | Cundinamarca | Huila | Nariño | Norte de Santander | Quindío | Risaralda | Santander | Tolima | Valle del Cauca | Caquetá
    +#> 3                                                                                           Bolívar | Cesar | La Guajira | Magdalena | Atlántico | Córdoba | Cundinamarca
    +#> 4                                                                                                                                                       Chocó | Magdalena
    +#> 5                                                                                                                          Amazonas | Caquetá | Meta | Putumayo | Vichada
    +#> 6                                                                                                          Antioquia | Caldas | Cauca | Nariño | Valle del Cauca | Tolima
    +#>                                                                                                                         source
    +#> 1                                                                Bulletin of the American Museum of Natural History 35:191-238
    +#> 2                                                                                                     Biota Colombiana 1:43-75
    +#> 3                                                                Bulletin of the American Museum of Natural History 35:191-238
    +#> 4 Pp. 21-59, en: Biology and management of the Cervidae (CM Wemmer, ed.). Smithsonian Institution Press, Washington, D.C., USA
    +#> 5                                                                Bulletin of the American Museum of Natural History 35:191-238
    +#> 6                                                                Bulletin of the American Museum of Natural History 35:191-238
    +#>   endemic        english_name
    +#> 1      No                <NA>
    +#> 2      No  Little Red Brocket
    +#> 3      No                <NA>
    +#> 4      No Mexican Red Brocket
    +#> 5      No                <NA>
    +#> 6      No                <NA>
    +
    +
    +
    +
    + + +
    + + +
    + +
    +

    +

    Site built with pkgdown 2.0.7.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 0000000..88ad827 --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/logo.png b/docs/logo.png new file mode 100644 index 0000000..507e587 Binary files /dev/null and b/docs/logo.png differ diff --git a/docs/news/index.html b/docs/news/index.html new file mode 100644 index 0000000..6447fa7 --- /dev/null +++ b/docs/news/index.html @@ -0,0 +1,105 @@ + +Changelog • mammalcol + + +
    +
    + + + +
    +
    + + +
    + +
    • Initial CRAN submission.
    • +
    • Added vignettes
    • +
    • Added mammalmap function
    • +
    +
    + + + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 0000000..80ea5b8 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,384 @@ +/* Sticky footer */ + +/** + * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ + * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css + * + * .Site -> body > .container + * .Site-content -> body > .container .row + * .footer -> footer + * + * Key idea seems to be to ensure that .container and __all its parents__ + * have height set to 100% + * + */ + +html, body { + height: 100%; +} + +body { + position: relative; +} + +body > .container { + display: flex; + height: 100%; + flex-direction: column; +} + +body > .container .row { + flex: 1 0 auto; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; + flex-shrink: 0; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +/* Ensure in-page images don't run outside their container */ +.contents img { + max-width: 100%; + height: auto; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +dd { + margin-left: 3em; +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + display: none; + margin-left: 5px; + width: 20px; + height: 20px; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; +} + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Navbar submenu --------------------------*/ + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu>.dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover>.dropdown-menu { + display: block; +} + +.dropdown-submenu>a:after { + display: block; + content: " "; + float: right; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; + border-width: 5px 0 5px 5px; + border-left-color: #cccccc; + margin-top: 5px; + margin-right: -10px; +} + +.dropdown-submenu:hover>a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left>.dropdown-menu { + left: -100%; + margin-left: 10px; + border-radius: 6px 0 6px 6px; +} + +/* Sidebar --------------------------*/ + +#pkgdown-sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} + +#pkgdown-sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#pkgdown-sidebar h2:first-child { + margin-top: 0; +} + +#pkgdown-sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* bootstrap-toc tweaks ------------------------------------------------------*/ + +/* All levels of nav */ + +nav[data-toggle='toc'] .nav > li > a { + padding: 4px 20px 4px 6px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; +} + +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 5px; + color: inherit; + border-left: 1px solid #878787; +} + +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 5px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; + border-left: 2px solid #878787; +} + +/* Nav: second level (shown on .active) */ + +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} + +nav[data-toggle='toc'] .nav .nav > li > a { + padding-left: 16px; + font-size: 1.35rem; +} + +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 15px; +} + +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 15px; + font-weight: 500; + font-size: 1.35rem; +} + +/* orcid ------------------------------------------------------------------- */ + +.orcid { + font-size: 16px; + color: #A6CE39; + /* margins are required by official ORCID trademark and display guidelines */ + margin-left:4px; + margin-right:4px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} + +.ref-index td {vertical-align: top; min-width: 100px} +.ref-index .icon {width: 40px;} +.ref-index .alias {width: 40%;} +.ref-index-icons .alias {width: calc(40% - 40px);} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre, code, pre code { + background-color: #f8f8f8; + color: #333; +} +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} + +pre { + border: 1px solid #eee; +} + +pre .img, pre .r-plt { + margin: 5px 0; +} + +pre .img img, pre .r-plt img { + background-color: #fff; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.error {font-weight: bolder;} +.warning {font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; +} + +/* headroom.js ------------------------ */ + +.headroom { + will-change: transform; + transition: transform 200ms linear; +} +.headroom--pinned { + transform: translateY(0%); +} +.headroom--unpinned { + transform: translateY(-100%); +} + +/* mark.js ----------------------------*/ + +mark { + background-color: rgba(255, 255, 51, 0.5); + border-bottom: 2px solid rgba(255, 153, 51, 0.3); + padding: 1px; +} + +/* vertical spacing after htmlwidgets */ +.html-widget { + margin-bottom: 10px; +} + +/* fontawesome ------------------------ */ + +.fab { + font-family: "Font Awesome 5 Brands" !important; +} + +/* don't display links in code chunks when printing */ +/* source: https://stackoverflow.com/a/10781533 */ +@media print { + code a:link:after, code a:visited:after { + content: ""; + } +} + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 0000000..6f0eee4 --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,108 @@ +/* http://gregfranko.com/blog/jquery-best-practices/ */ +(function($) { + $(function() { + + $('.navbar-fixed-top').headroom(); + + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); + }); + + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } + } + + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); + + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } + + /* Clipboard --------------------------*/ + + function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); + } + + if(ClipboardJS.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $("div.sourceCode").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); + } +})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml new file mode 100644 index 0000000..3cbac58 --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,9 @@ +pandoc: 3.1.1 +pkgdown: 2.0.7 +pkgdown_sha: ~ +articles: {} +last_built: 2024-03-25T05:11Z +urls: + reference: https://dlizcano.github.io/mammalcol/reference + article: https://dlizcano.github.io/mammalcol/articles + diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png new file mode 100644 index 0000000..17a3580 Binary files /dev/null and b/docs/reference/Rplot001.png differ diff --git a/docs/reference/colmap.html b/docs/reference/colmap.html new file mode 100644 index 0000000..e9d9ac4 --- /dev/null +++ b/docs/reference/colmap.html @@ -0,0 +1,188 @@ + +colmap Dataset — colmap • mammalcol + + +
    +
    + + + +
    +
    + + +
    +

    The colmap dataset Simple feature collection with 33 features and 11 fields. This version +was obtained from: GDAM using: +colmap <- sf::st_as_sf(gadm(country="COL", level=1, path=tempdir())) +al later apply st_simplify with a tolerance of 1km: +colmap <- st_simplify(colmap, preserveTopology = FALSE, dTolerance = 1000)

    +
    + +
    +
    colmap
    +
    + +
    +

    Format

    +

    Simple feature collection with 33 features and 11 fields:

    GID_1
    +

    id from original GDAM

    + +
    GID_0
    +

    id from original GDAM

    + +
    COUNTRY
    +

    Colombia.

    + +
    NAME_1
    +

    Departamentos.

    + +
    VARNAME_1
    +

    class name GDAM.

    + +
    NL_NAME_1
    +

    order name of GDAM.

    + +
    TYPE_1
    +

    family name of of GDAM.

    + +
    ENGTYPE_1
    +

    name of of GDAM.

    + +
    CC_1
    +

    name of of GDAM

    + +
    HASC_1
    +

    name of of GDAM

    + +
    ISO_1
    +

    name of of GDAM

    + +
    geometry
    +

    polygons of GDAM

    + + +
    +
    +

    Details

    +

    This dataset is designed to provide users with a companion map to +plot the mammal distribution per departamento

    +
    +
    +

    References

    +

    The dataset is based on the "List of the Mammals of Colombia" by Ramírez-Chaves 2021.

    +
    +
    +

    See also

    +

    For more information about the "mammalcol" package and the data sources, visit +the package's GitHub repository: https://github.com/dlizcano/mammalcol

    +
    +
    +

    Author

    +

    Data compilation: Ramírez-Chaves 2021, Package implementation: Diego J. Lizcano

    +
    + +
    +

    Examples

    +
    # Load the mammalcol package
    +library(mammalcol)
    +
    +# Access the mammalcol_tab dataset
    +data("colmap")
    +#> Warning: data set 'colmap' not found
    +
    +# Display the first few rows
    +head(colmap)
    +#> Error in eval(expr, envir, enclos): object 'colmap' not found
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/figures/README-example3-1.png b/docs/reference/figures/README-example3-1.png new file mode 100644 index 0000000..a571eda Binary files /dev/null and b/docs/reference/figures/README-example3-1.png differ diff --git a/docs/reference/figures/logo.png b/docs/reference/figures/logo.png new file mode 100644 index 0000000..507e587 Binary files /dev/null and b/docs/reference/figures/logo.png differ diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..0d465fb --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,117 @@ + +Function reference • mammalcol + + +
    +
    + + + +
    +
    + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    colmap

    +

    colmap Dataset

    +

    mammalmap()

    +

    Plot a map Data for one species of the List of the Mammals of Colombia

    +

    search_mammalcol()

    +

    Retrieve Data from the List of the Mammals of Colombia

    +

    taxon

    +

    taxon Dataset

    + + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/mammalcol-package.html b/docs/reference/mammalcol-package.html new file mode 100644 index 0000000..56eb884 --- /dev/null +++ b/docs/reference/mammalcol-package.html @@ -0,0 +1,117 @@ + +mammalcol: Access to the List of Mammals Species of Colombia — mammalcol-package • mammalcol + + +
    +
    + + + +
    +
    + + +
    +

    +

    Allows access to the data found in the species list featured in the renowned "Ramírez-Chaves, et al. 2021. Checklist of the Mammals (Mammalia) of Colombia”. Mammalogy Notes 7(2),253. https://doi.org/10.47603/mano.v7n2.253. This publication stands as one of Colombia's most comprehensive reviews of mammal diversity. The dataset incorporates detailed species accounts and has been meticulously structured for effortless utilization within the R environment.

    +
    + + + +
    +

    Author

    +

    Maintainer: Diego J. Lizcano dj.lizcano@gmail.com (ORCID)

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/mammalmap.html b/docs/reference/mammalmap.html new file mode 100644 index 0000000..a85eeb7 --- /dev/null +++ b/docs/reference/mammalmap.html @@ -0,0 +1,137 @@ + +Plot a map Data for one species of the List of the Mammals of Colombia — mammalmap • mammalcol + + +
    +
    + + + +
    +
    + + +
    +

    This function retrieve the locality data for one species in +the MammalCol pacakage dataset, and returns a map of Departamentos +where the species has been recorded.

    +
    + +
    +
    mammalmap(species)
    +
    + +
    +

    Arguments

    +
    species
    +

    A character string containing the name of the species to plot the map.

    + +
    +
    +

    Value

    + + +

    A map for the species.

    +
    +
    +

    Details

    +

    The function does not allows fuzzy matching, so the specie name should be correct. +It is advised to run first the search_mammalcol function.

    +
    + +
    +

    Examples

    +
    
    +species <- "Tapirus pinchaque" 
    +mammalmap(species)
    +#> Error in mammalmap(species): could not find function "mammalmap"
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/search_mammalcol.html b/docs/reference/search_mammalcol.html new file mode 100644 index 0000000..7963b2b --- /dev/null +++ b/docs/reference/search_mammalcol.html @@ -0,0 +1,144 @@ + +Retrieve Data from the List of the Mammals of Colombia — search_mammalcol • mammalcol + + +
    +
    + + + +
    +
    + + +
    +

    This function takes a list of Mammal species names, searches for their data in +the MammalCol pacakage dataset, and returns a data frame containing the relevant +information for each species.

    +
    + +
    +
    search_mammalcol(splist, max_distance = 0.2)
    +
    + +
    +

    Arguments

    +
    splist
    +

    A character vector containing the names of the species to search for.

    + + +
    max_distance
    +

    The maximum allowed distance for fuzzy matching of species names. +Defaults to 0.2.

    + +
    +
    +

    Value

    + + +

    A data frame containing the retrieved information for each species.

    +
    +
    +

    Details

    +

    The function allows fuzzy matching for species names with a maximum +distance threshold to handle potential typos or variations in species names.

    +
    + +
    +

    Examples

    +
    
    +splist <- c("Tapirus bairdii", "Tapirus pinchaque", "Tapirus terrestris",
    +            "Tapirus terrestris", "tapir terrestre", "Pudu mephistophiles")
    +
    +search_mammalcol(splist)
    +#> Error in search_mammalcol(splist): could not find function "search_mammalcol"
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/taxon.html b/docs/reference/taxon.html new file mode 100644 index 0000000..896fb5f --- /dev/null +++ b/docs/reference/taxon.html @@ -0,0 +1,213 @@ + +taxon Dataset — taxon • mammalcol + + +
    +
    + + + +
    +
    + + +
    +

    The taxon dataset comprises a tibble containing information +regarding mammal species documented in Colombia, sourced from the "List of the +mammals of Peru" compiled by Ramírez-Chaves 2021. It encompasses various +details, including scientific names, English names, Spanish names, order, +family, threat status and distribution of each species. The table is a +variant of the taxon table from https://doi.org/10.15472/kl1whs

    +
    + +
    +
    taxon
    +
    + +
    +

    Format

    +

    A tibble with 548 rows and 25 columns:

    id
    +

    id from original taxon table.

    + +
    scientificName
    +

    Scientific name of the mammal species.

    + +
    kingdom
    +

    kingdom name of the mammal species.

    + +
    phylum
    +

    phylum name of the mammal species.

    + +
    class
    +

    class name of the mammal species.

    + +
    order
    +

    order name of the mammal species.

    + +
    family
    +

    family name of the mammal species.

    + +
    genus
    +

    genus name of the mammal species.

    + +
    specificEpithet
    +

    specificEpithet name of the mammal species.

    + +
    taxonRank
    +

    taxon Rank name of the mammal species.

    + +
    scientificNameAuthorship
    +

    species name´s author of the mammal species.

    + +
    taxonRemarks
    +

    elevation of the mammal species.

    + +
    bibliographicCitation
    +

    bibliographicCitation of the mammal species.

    + +
    inMDD
    +

    1 if it is included on the Mammal Diverity Data Base, 0 not included.

    + +
    Col_redlist
    +

    conservation status in Colombia for the mammal species.

    + +
    distribution
    +

    Departamento were the mammal is present.

    + +
    source
    +

    reference for the distribution.

    + +
    endemic
    +

    Yes if it is endemic from Colombia, otherwise No.

    + +
    english_name
    +

    english_name of the mammal species.

    + + +
    +
    +

    Details

    +

    This dataset is designed to provide users with comprehensive +information about the mammal species found in Colombia, as documented +by Ramírez-Chaves 2021. It is organized for easy access and utilization within +the R environment.

    +
    +
    +

    References

    +

    The dataset is based on the "List of the Mammals of Colombia" by Ramírez-Chaves 2021.

    +
    +
    +

    See also

    +

    For more information about the "mammalcol" package and the data sources, visit +the package's GitHub repository: https://github.com/dlizcano/mammalcol

    +
    +
    +

    Author

    +

    Data compilation: Ramírez-Chaves 2021, Package implementation: Diego J. Lizcano

    +
    + +
    +

    Examples

    +
    # Load the mammalcol package
    +library(mammalcol)
    +
    +# Access the mammalcol_tab dataset
    +data("taxon")
    +#> Warning: data set 'taxon' not found
    +
    +# Display the first few rows
    +head(taxon)
    +#> Error in eval(expr, envir, enclos): object 'taxon' not found
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..8892c63 --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,39 @@ + + + + https://dlizcano.github.io/mammalcol/404.html + + + https://dlizcano.github.io/mammalcol/authors.html + + + https://dlizcano.github.io/mammalcol/index.html + + + https://dlizcano.github.io/mammalcol/LICENSE-text.html + + + https://dlizcano.github.io/mammalcol/LICENSE.html + + + https://dlizcano.github.io/mammalcol/news/index.html + + + https://dlizcano.github.io/mammalcol/reference/colmap.html + + + https://dlizcano.github.io/mammalcol/reference/index.html + + + https://dlizcano.github.io/mammalcol/reference/mammalcol-package.html + + + https://dlizcano.github.io/mammalcol/reference/mammalmap.html + + + https://dlizcano.github.io/mammalcol/reference/search_mammalcol.html + + + https://dlizcano.github.io/mammalcol/reference/taxon.html + +