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 @@ + + +
+ + + + +YEAR: 2024 +COPYRIGHT HOLDER: Sahir Bhatnagar ++ +
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.
+The goal of mammalcol is to allow easy access to the List of Mammal Species of Colombia.
+You can install the development version of mammalcol from GitHub with:
+
+# install.packages("devtools")
+devtools::install_github("dlizcano/mammalcol")
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
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")
+
+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>
NEWS.md
+ 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
Simple feature collection with 33 features and 11 fields:
id from original GDAM
id from original GDAM
Colombia.
Departamentos.
class name GDAM.
order name of GDAM.
family name of of GDAM.
name of of GDAM.
name of of GDAM
name of of GDAM
name of of GDAM
polygons of GDAM
This dataset is designed to provide users with a companion map to +plot the mammal distribution per departamento
+The dataset is based on the "List of the Mammals of Colombia" by Ramírez-Chaves 2021.
+For more information about the "mammalcol" package and the data sources, visit +the package's GitHub repository: https://github.com/dlizcano/mammalcol
+ All functions+ + |
+ |
---|---|
+ + | +colmap Dataset |
+
+ + | +Plot a map Data for one species of the List of the Mammals of Colombia |
+
+ + | +Retrieve Data from the List of the Mammals of Colombia |
+
+ + | +taxon Dataset |
+
R/mammalcol-package.R
+ mammalcol-package.Rd
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.
+Useful links:
R/mammalmap.R
+ mammalmap.Rd
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)
A character string containing the name of the species to plot the map.
A map for the species.
+The function does not allows fuzzy matching, so the specie name should be correct. +It is advised to run first the search_mammalcol function.
+
+species <- "Tapirus pinchaque"
+mammalmap(species)
+#> Error in mammalmap(species): could not find function "mammalmap"
+
+
R/get_mammalcol.R
+ search_mammalcol.Rd
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)
A character vector containing the names of the species to search for.
The maximum allowed distance for fuzzy matching of species names. +Defaults to 0.2.
A data frame containing the retrieved information for each species.
+The function allows fuzzy matching for species names with a maximum +distance threshold to handle potential typos or variations in species names.
+
+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"
+
+
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
A tibble with 548 rows and 25 columns:
id from original taxon table.
Scientific name of the mammal species.
kingdom name of the mammal species.
phylum name of the mammal species.
class name of the mammal species.
order name of the mammal species.
family name of the mammal species.
genus name of the mammal species.
specificEpithet name of the mammal species.
taxon Rank name of the mammal species.
species name´s author of the mammal species.
elevation of the mammal species.
bibliographicCitation of the mammal species.
1 if it is included on the Mammal Diverity Data Base, 0 not included.
conservation status in Colombia for the mammal species.
Departamento were the mammal is present.
reference for the distribution.
Yes if it is endemic from Colombia, otherwise No.
english_name of the mammal species.
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.
+The dataset is based on the "List of the Mammals of Colombia" by Ramírez-Chaves 2021.
+For more information about the "mammalcol" package and the data sources, visit +the package's GitHub repository: https://github.com/dlizcano/mammalcol