diff --git a/DESCRIPTION b/DESCRIPTION index 71022ac5daab33141376dec979b0565223ddd55e..53b31d6a67649c850170d284059e9632b377f433 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: floodam.data Title: Collect and Process Data on Flood Damage (French Context) -Version: 0.9.35.0 +Version: 0.9.36.0 Authors@R: c( person(given = "Frédéric", family = "Grelot", @@ -49,5 +49,5 @@ Suggests: DT, testthat Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.2 +RoxygenNote: 7.2.3 VignetteBuilder: knitr diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000000000000000000000000000000000000..d48cac7f589c98cccd734a764b1bcae17c0e21b7 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,129 @@ +# floodam.data 0.9.36.0 + +## Enhancements + +* nomenclature_clc + * nomemclature for Corine Land Cover and some color codes + +## Documentation + +* _pkgdown.yml + * adaptation to pkgdown 2.0.7 + +# floodam.data 0.9.35.0 + +## Enhancements + +* adapt_admin_express + * replace adapt.admin_express + * use add_log_info for journal du nouveau système de journal + * use read_with_scheme to read and format data + * use save_archive to save result + * option 'export' renamed in 'extension' for cohérence with save_archive + * documentation updated +* analyse_archive + * function within its own file and exporteds + * treat 2 formats ('ign' & 'floodam.data') + * addition of warnings + * function tested in test_analyse_archive + * **TO DO: put information for format in a global variable** +* Ajout de format_archive + * permet de créer des noms formattés des archives à partir + d'informations standardisées + * origin = "floodam.data" (défault) pour créer les noms des archives de + sauvegarde + * origin = "ign" pour créer les noms à la façon IGN (inverse de + analyse_archive) + * origin = "version" pour créer des patterns pour chercher dans les noms + façon IGN. + * tests dans test_format_archive +* Ajout de save_archive + * sauvegarde d'une archive de façon standardisée + * analyse le path pour trouver les informations (possibilité d'utiliser + l'option origin pour spécifier si origin = "floodam.data" ou origin = + "ign") + * extension peut-être écrasée par paramètre dédié + * gestion du scope (attention ça peut-être un facteur qui découpe + les données ou le nom d'une colonne dans cet input). + * extension gérée pour le moment: rds + * tests dans test_save_archive +* Amélioration de downlaod_archive + * renvoie un message si aucune archive n'est trouvée avec les options + demandées + * utilisation de add_journal_new au lieu de add_journal +* Amélioration de add_journal + * reprise de add_journal_new + * ancienne add_journal renommée temporairement en add_journal_old le + temps de la migration + * meilleure présentation des sous-tâches en introduisant le paramètre + degree +* Ajout de write_journal + * permet d'écrire un journal produit par add_journal_new soit au format + "csv", soit au format "log" en fonction de l'extension du fichier + * si aucun fichier n'est donné, le message au format "log" est affiché + sur la sortie standard + * si un fichier existant est donné, le journal est ajouté au précédent, + quelque soit le format choisi ("log" ou "csv") + * Non exportée +* Ajout de basename_core + * trouve le nom d'une archive en enlevant le path et les doubles + extensions de type .csv.gz ou .7z.001 notamment + * déploiement dans les fonctions + * tests dans test_basename_utilities +* Ajout de basename_ext + * trouve les extensions y compris les doubles de type .csv.gz ou .7z.001 + notamment + * déploiements dans les fonctions + * tests +* Ajout de format_journal + * permet de formatter un journal (ou une partie de journal) pour + préparer des messages au format "log" + * Non exportée +* Amélioration de read_with_scheme + * wrapper pour différentes fonctions plus spécifiques + * gère csv, csv.gz, shp, gpkg, shp from 7z, gpkg from 7z, zip + * pour zip, attention fait appel à une commande 'system' en modifiant + le nom du fichier pour faire une commande qui sera détectée par + data.table::fread, et présume que le format sera csv et pourra être lu + avec read_csv_with_scheme + * pour zip, modifie temporairemen l'option + 'datatable.fread.input.cmd.message' pour éviter le message renvoyé par + data.table::fread +* Ajout de read_csv_with_scheme + * correspond à ancienne version de read_with_scheme qui était csv + spécifique +* Ajout de read_gpkg_with_scheme + * gestion de gpkg avec scheme et projection +* Ajout de read_shp_with_scheme + * gestion de shp avec scheme et projection +* Amélioration de read_shp_from_7z + * Ancienne version n'était pas finalisée + * Extraction en fonction de la layer spécifiée +* Amélioration de read_gpkg_from_7z + * Séparation claire de la décompression et de la lecture + * Sécurité si plusieurs gpkg +* download_admin_express + * transformation de download.admin_express + * meilleure gestion des options (et match.arg) +* scheme_admin_express_3_1 (data) + * nouveau format à partir des infos IGN (version 3-1) + * style des noms des variables "." → "_" + * MaJ de data-raw/scheme.R et R/data.R pour intégration & documentation +* scheme_admin_express_2_0 (data) + * renommage de scheme_admin_express (data) qui ne faisait pas mention de + la version (version 2-0) + * style des noms des variables "." → "_" + * MaJ de data-raw/scheme.R et R/data.R pour intégration & documentation +* scheme_insee_2019 (data) + * renommage de certaines variables ('type_loge' en 'type', 'n_loge' en + 'dwelling', 'cat_loge' en 'usage') pour plus de cohérénces +* documentation + * corrections de coquilles (à la volée) pour les datasets + * regroupement des documentions pour fonction de la famille + read_with_scheme +* data.cquest.org + * toutes les mentions à l'adresse passent en https au lieu de http +* Roxygen + * utilisation de l'option markdown = TRUE (dans DESCRIPTION) + +## Bugs diff --git a/R/adapt_admin_express.R b/R/adapt_admin_express.R index d227dc01ba6fd9700de7defc70d62c97505fe03a..d753b5ce9feb140be74294798020c98a1ab1843c 100644 --- a/R/adapt_admin_express.R +++ b/R/adapt_admin_express.R @@ -200,208 +200,4 @@ adapt_admin_express = function( if (retrieve) { return(invisible(result)) } -} - -adapt.admin_express = function(origin, - destination, - archive, - export = "rds", - scheme = floodam.data::scheme_admin_express, - layer = NULL, - projection = 4326, - retrieve = FALSE, - verbose = FALSE) { - - ### Recursive call if archive is missing - if (missing(archive)) {archive = list.files(origin, pattern = ".(7z.001|7z|zip)$")} - if (length(archive) > 1) - return(lapply(archive, - adapt.admin_express, - origin = origin, - destination = destination, - export = export, - scheme = scheme, - layer = layer, - projection = projection, - retrieve = retrieve, - verbose = verbose)) - if (length(archive) == 0) - return(NULL) - - ### Check for layer. Recursive call if layer is lengthy - if (is.null(layer)) layer = unique(scheme[["layer"]]) - test = ! layer %in% unique(scheme[["layer"]]) - if (any(test)) { - add_journal_old( - sprintf("Some layers are not admissible (%s). They are removed.", paste(layer[test], collapse = ", ")), - verbose = TRUE - ) - layer = layer[!test] - } - if (length(layer) == 0) { - add_journal_old("No layer is admissible. Nothing is done", verbose = TRUE) - return(NULL) - } - if (length(layer) > 1) - return(lapply(layer, - adapt.admin_express, - origin = origin, - archive = archive, - destination = destination, - export = export, - scheme = scheme, - projection = projection, - retrieve = retrieve, - verbose = verbose)) - - ### Analyse archive - # Step 1. Good format to uncompress - analyse = regmatches(archive, regexec("(.*?)[.](7z[.]001|7z|zip)$", archive, perl = TRUE))[[1]] - if (length(analyse) == 0) { - add_journal_old(sprintf("Trouble with name format of archive %s. Nothing is done.", archive), verbose = TRUE) - return(NULL) - } - name = analyse[2] - ext = analyse[3] - # Step 2. Good information for date. - analyse = regmatches(name, regexec("([0-9]{4}-[0-9]{2}-[0-9]{2})", name, perl = TRUE))[[1]] - if (length(analyse) == 0) { - add_journal_old(sprintf("Trouble with name format of archive %s. Nothing is done.", archive), verbose = TRUE) - return(NULL) - } - date = analyse[2] - - ### Start journal information - dir.create(destination, showWarnings = FALSE, recursive = TRUE) # Check if error may be generated. - start_time = Sys.time() - journal = add_journal_old( - "WARNING: This file is automatically produced by floodam.data. Do not edit by hand.", "", - first = TRUE) - journal = add_journal_old( - sprintf("%s/%s adpated by floodam.data (%s)", archive, layer, utils::packageVersion("floodam.data")), - journal = journal, verbose = verbose, first = TRUE) - journal = add_journal_old(sprintf("Starting time: %s", Sys.time()), journal = journal, verbose = verbose) - on.exit(journal <- add_journal_old("", - sprintf("Total time elapsed %s", fmt(Sys.time() - start_time)), - journal = journal, verbose = verbose, first = TRUE)) - on.exit(write(journal, file.path(destination, sprintf("%s_%s.%s", name, layer, "log"))), add = TRUE) - - ### Extract archive - # try to extract layer - path_temp = file.path(tempdir(), date) - command_extract = sprintf( - "7z e -aoa %s -o%s %s* -r", - file.path(origin, archive), path_temp, layer) - - try_extract = try( - system(command_extract, ignore.stdout = TRUE, ignore.stderr = TRUE), - silent = TRUE) - - if (length(list.files(path_temp, ".shp")) == 0) { - journal = add_journal_old( - sprintf("Aborting, no %s shapefiles found in %s.", layer, archive), - journal = journal, verbose = verbose) - unlink(path_temp, recursive = TRUE) - return(NULL) - } - - ### Read file - # From here, it is supposed that file corresponds to ADMIN_EXPRESS version 2.0 - input = suppressWarnings( - sf::st_read( - file.path(path_temp, list.files(path_temp, sprintf("%s.shp", layer))), - stringsAsFactors = FALSE, quiet = TRUE) - ) - - journal = add_journal_old( - sprintf("Layer %s successfully loaded.", layer), - journal = journal, verbose = verbose) - - ### Manage data format - geometry = sf::st_geometry(input) - sf::st_geometry(input) = NULL - sub_scheme = scheme[as.logical(scheme[["keep"]]) & scheme[["layer"]] == layer, ] - # Keep only data in scheme, rename data as in scheme - input = input[sub_scheme[["name.origin"]]] - names(input) = sub_scheme[["name"]] - # format factors - selection = sub_scheme[["name"]][sub_scheme[["type"]] == "factor"] - input[selection] = lapply(input[selection], as.factor) - # format numeric - selection = sub_scheme[["name"]][sub_scheme[["type"]] == "numeric"] - input[selection] = lapply(input[selection], as.numeric) - # format integer - selection = sub_scheme[["name"]][sub_scheme[["type"]] == "integer"] - input[selection] = lapply(input[selection], as.integer) - # Add information to journal - test = sapply(input, class) == sub_scheme[["type"]] - if (all(test)) { - journal = add_journal_old("All variables have the good type.", journal = journal, verbose = verbose) - } else { - journal = add_journal_old( - sprintf("Some variables do not have the good type. Check %s.", - paste("'", names(test)[!test], "'", sep = "", collapse = ", ")), - journal = journal, verbose = verbose) - } - sf::st_geometry(input) = geometry - rm(geometry) - - ### Manage projection - # Check if any projection, if not put default one - if (is.na(sf::st_crs(input))) { - sf::st_crs(input) = 4326 - journal = add_journal_old( - sprintf("%s/%s has no projection. Set to EPSG:4326.", archive, layer), - journal = journal, verbose = verbose) - } - # Transform projection if asked - if (!is.null(projection)) { - temp = try(sf::st_crs(projection), silent = TRUE) - projection = if ("crs" %in% class(temp)) temp else projection - if ("crs" %in% class(projection)) { - input = sf::st_transform(input, crs = projection) - journal = add_journal_old( - sprintf("projection %s applied to %s/%s.", projection[["input"]], archive, layer), - journal = journal, verbose = verbose) - } else { - journal = add_journal_old( - sprintf("projection %s could not be applied to %s/%s.", projection, archive, layer), - journal = journal, verbose = verbose) - } - } - - ### Make geometry valid - initial.area = sum(sf::st_area(input)) - input = sf::st_make_valid(input) - geometry_type = sf::st_geometry_type(input) - selection = geometry_type %in% c("MULTIPOLYGON", "POLYGON") - input = suppressWarnings(sf::st_cast(input[selection, ], "MULTIPOLYGON")) - final.area = sum(sf::st_area(input)) - diff.area = round((final.area - initial.area) / initial.area, 10) - unselected = length(geometry_type) - sum(selection) - journal = add_journal_old( - sprintf("Layer %s corrected (Diff in area %s, unselected %s).", layer, diff.area, unselected), - journal = journal, verbose = verbose) - - ### Write data - # For commune, write by department - dir.create(destination, showWarnings = FALSE, recursive = TRUE) - if (layer == "COMMUNE") { - input = split(input, input[["department"]]) - mapply(saveRDS, - input, - file.path(destination, sprintf("%s_%s_%s.rds", tolower(layer), format_scope(names(input)), date)) - ) - journal = add_journal_old(sprintf("Layer %s saved by department (%s files generated).", layer, length(input)), - journal = journal, verbose = verbose) - } else { - saveRDS(input, file.path(destination, sprintf("%s_%s.rds", tolower(layer), date))) - journal = add_journal_old(sprintf("Layer %s saved.", layer), - journal = journal, verbose = verbose) - } - - ### Retrieve result - if (retrieve) { - return(invisible(input)) - } } \ No newline at end of file diff --git a/R/data.R b/R/data.R index fe28f9b68b8da8168665a79fb203c03a5f5bdf31..7fe24936f00ea3319033c4785a59f841efab4efa 100644 --- a/R/data.R +++ b/R/data.R @@ -124,6 +124,27 @@ #' } "naf_label" +#' Nomenclature of Corine Land Cover with color definitions +#' +#' A dataset containing the labels in French and English corresponding with +#' the Corine Land Cover (CLC) typology. It also gives color definition for +#' each types. Those colors are those that may be used internally in +#' floodam.data and also those given by the French ministrey of environment. +#' +#' @format A data frame with 28 rows and 2 variables: +#' \describe{ +#' \item{level}{character, level of classification in CLC.} +#' \item{clc}{character, classification in CLC.} +#' \item{clc_label_fr}{character, label in French corresponding with the +#' clc code.} +#' \item{clc_label_en}{character, label in English corresponding with the +#' clc code.} +#' \item{col}{character, color definition for floodam.data usage.} +#' \item{col_fr}{character, color definition by the French ministery of +#' environment.} +#' } +"nomenclature_clc" + #' Nomenclature (in French) of RPG version 1.0 #' #' A dataset containing the label in French corresponding with @@ -137,7 +158,6 @@ #' } "nomenclature_rpg_1" - #' Nomenclature (in French) of RPG version 2.0 #' #' A dataset containing the label in French corresponding with diff --git a/_pkgdown.yml b/_pkgdown.yml index 2cd346bd954895969cb1e6dc4b1e7a2d4e4f8eaf..01f33483bd4348e3cc13817a58745e5a7e66b29f 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,29 +1,31 @@ -articles: -- title: Introduction -- title: Introduction to the library - navbar: Introduction - contents: - - download-data - -- title: database (English) - desc: Description of database managed - navbar: database (En) - contents: - - bd_topo_en - -- title: database (French) - desc: French description of database managed - navbar: database (Fr) - contents: - - admin_express_fr - - ban_fr - - bd_topo_fr - - gaspar_fr - - rpg_fr - -- title: Processes (English) - desc: Description of some processes - navbar: Processes (En) - contents: - - bd_topo_dwelling_en - +navbar: + components: + articles: + text: Articles + menu: + - text: Introduction + - text: Introduction to the library + href: articles/download-data.html + - text: ------- + - text: database (English) + - text: BD Topo + href: articles/bd_topo_en.html + - text: ------- + - text: database (French) + - text: Admin Express + href: admin_express_fr + - text: BAN + href: articles/ban_fr.html + - text: BD Topo + href: articles/bd_topo_fr.html + - text: Gaspar + href: articles/gaspar_fr.html + - text: RPG + href: articles/rpg_fr.html + - text: ------- + - text: Processes (English) + - text: From BD Topo to dwelling + href: articles/bd_topo_dwelling_en.html + - text: ------- + - text: Other articles + href: articles/index.html diff --git a/data-raw/scheme.R b/data-raw/scheme.R index 5a7088fd35db31ca87210038a896a40752ef0165..d32dc6f7a8169b44c9e76307ef134bd076ca4ecd 100644 --- a/data-raw/scheme.R +++ b/data-raw/scheme.R @@ -2,33 +2,68 @@ setwd("floodam.data") -category_label = data.table::fread("inst/extdata/category_label.csv", data.table = FALSE, colClasses = "character") +category_label = data.table::fread( + "inst/extdata/category_label.csv", + data.table = FALSE, + colClasses = "character" +) Encoding(category_label[["label.fr"]]) = "UTF-8" usethis::use_data(category_label, overwrite = TRUE) -catnat_classification = data.table::fread("inst/extdata/catnat_classification.csv", data.table = FALSE, colClasses = "character") -catnat_classification[-(1:2)] = lapply(catnat_classification[-(1:2)], as.logical) -catnat_classification[-(1:2)] = lapply(catnat_classification[-(1:2)], function(x){x[is.na(x)] = FALSE ; return(x)}) +catnat_classification = data.table::fread( + "inst/extdata/catnat_classification.csv", + data.table = FALSE, + colClasses = "character" +) +catnat_classification[-(1:2)] = lapply( + catnat_classification[-(1:2)], + as.logical +) +catnat_classification[-(1:2)] = lapply( + catnat_classification[-(1:2)], + function(x){x[is.na(x)] = FALSE ; return(x)} +) Encoding(catnat_classification[["catnat_label_fr"]]) = "UTF-8" usethis::use_data(catnat_classification, overwrite = TRUE) -pprn_classification = data.table::fread("inst/extdata/pprn_classification.csv", data.table = FALSE, colClasses = "character") -pprn_classification[-(1:2)] = lapply(pprn_classification[-(1:2)], as.logical) -pprn_classification[-(1:2)] = lapply(pprn_classification[-(1:2)], function(x){x[is.na(x)] = FALSE ; return(x)}) +pprn_classification = data.table::fread( + "inst/extdata/pprn_classification.csv", + data.table = FALSE, + colClasses = "character" +) +pprn_classification[-(1:2)] = lapply( + pprn_classification[-(1:2)], + as.logical +) +pprn_classification[-(1:2)] = lapply( + pprn_classification[-(1:2)], + function(x){x[is.na(x)] = FALSE ; return(x)} +) Encoding(pprn_classification[["hazard_label_fr"]]) = "UTF-8" usethis::use_data(pprn_classification, overwrite = TRUE) -commune_so_ii = data.table::fread("inst/extdata/commune_so_ii.csv", data.table = FALSE) +commune_so_ii = data.table::fread( + "inst/extdata/commune_so_ii.csv", + data.table = FALSE +) Encoding(commune_so_ii[["commune_name"]]) = "UTF-8" Encoding(commune_so_ii[["epci"]]) = "UTF-8" usethis::use_data(commune_so_ii, overwrite = TRUE) -department = data.table::fread("inst/extdata/department.csv", data.table = FALSE, colClasses = "character") +department = data.table::fread( + "inst/extdata/department.csv", + data.table = FALSE, + colClasses = "character" +) rownames(department) = department[["code"]] Encoding(department[["label.fr"]]) = "UTF-8" usethis::use_data(department, overwrite = TRUE) -region = data.table::fread("inst/extdata/region.csv", data.table = FALSE, colClasses = "character") +region = data.table::fread( + "inst/extdata/region.csv", + data.table = FALSE, + colClasses = "character" +) rownames(region) = region[["code"]] Encoding(region[["label.fr"]]) = "UTF-8" usethis::use_data(region, overwrite = TRUE) @@ -36,130 +71,218 @@ usethis::use_data(region, overwrite = TRUE) eaip_variable = c("ORIGINE", "IDENT", "DOCUMENT", "AUTEUR", "DATE_APPRO", "PRECISION", "THEME", "LIEN_RAPPO", "FOURNISS", "RETENU", "DATE_IMPOR", "geometry") usethis::use_data(eaip_variable, overwrite = TRUE) -nace_label = data.table::fread("inst/extdata/nace_label.csv", data.table = FALSE, - colClasses = c("integer", "character", "character", "character")) +nace_label = data.table::fread( + "inst/extdata/nace_label.csv", + data.table = FALSE, + colClasses = c("integer", "character", "character", "character") +) Encoding(nace_label[["label.en"]]) = "UTF-8" Encoding(nace_label[["label.fr"]]) = "UTF-8" usethis::use_data(nace_label, overwrite = TRUE) -naf_label = data.table::fread("inst/extdata/naf_label.csv", data.table = FALSE, - colClasses = c("integer", "character", "character")) +naf_label = data.table::fread( + "inst/extdata/naf_label.csv", + data.table = FALSE, + colClasses = c("integer", "character", "character") +) Encoding(naf_label[["label.fr"]]) = "UTF-8" usethis::use_data(naf_label, overwrite = TRUE) -naf_esane = data.table::fread("inst/extdata/naf_esane.csv", data.table = FALSE, colClasses = "character") -naf_esane[10:26] = lapply(naf_esane[10:26], gsub, pattern = ",", replacement = ".") -naf_esane[10:26] = lapply(naf_esane[10:26], as.numeric) +naf_esane = data.table::fread( + "inst/extdata/naf_esane.csv", + data.table = FALSE, + colClasses = "character" +) +naf_esane[10:26] = lapply( + naf_esane[10:26], + gsub, + pattern = ",", + replacement = "." +) +naf_esane[10:26] = lapply( + naf_esane[10:26], + as.numeric +) Encoding(naf_esane[["type"]]) = "UTF-8" usethis::use_data(naf_esane, overwrite = TRUE) -nomenclature_rpg_1 = - data.table::fread("inst/extdata/nomenclature_rpg_1.csv", data.table = FALSE, colClasses = "character") +nomenclature_clc = data.table::fread( + "inst/extdata/nomenclature_clc.csv", + data.table = FALSE, + colClasses = "character" +) +rownames(nomenclature_clc) = nomenclature_clc[["clc"]] +Encoding(nomenclature_clc[["clc_label_fr"]]) = "UTF-8" +usethis::use_data(nomenclature_clc, overwrite = TRUE) + +nomenclature_rpg_1 = data.table::fread( + "inst/extdata/nomenclature_rpg_1.csv", + data.table = FALSE, + colClasses = "character" +) rownames(nomenclature_rpg_1) = scheme_rpg_1[["group"]] Encoding(nomenclature_rpg_1[["group_label_fr"]]) = "UTF-8" usethis::use_data(nomenclature_rpg_1, overwrite = TRUE) -nomenclature_rpg_2 = - data.table::fread("inst/extdata/nomenclature_rpg_2.csv", data.table = FALSE, colClasses = "character") +nomenclature_rpg_2 = data.table::fread( + "inst/extdata/nomenclature_rpg_2.csv", + data.table = FALSE, + colClasses = "character" +) rownames(nomenclature_rpg_2) = scheme_rpg_1[["culture"]] Encoding(nomenclature_rpg_2[["culture_label_fr"]]) = "UTF-8" usethis::use_data(nomenclature_rpg_2, overwrite = TRUE) -scheme_admin_express_2_0 = - data.table::fread("inst/extdata/scheme_admin_express_2_0.csv", data.table = FALSE, colClasses = "character") +scheme_admin_express_2_0 = data.table::fread( + "inst/extdata/scheme_admin_express_2_0.csv", + data.table = FALSE, + colClasses = "character" +) scheme_admin_express_2_0[["keep"]] = as.logical(scheme_admin_express_2_0[["keep"]]) Encoding(scheme_admin_express_2_0[["label_fr"]]) = "UTF-8" Encoding(scheme_admin_express_2_0[["comment"]]) = "UTF-8" usethis::use_data(scheme_admin_express_2_0, overwrite = TRUE) -scheme_admin_express_3_1 = - data.table::fread("inst/extdata/scheme_admin_express_3_1.csv", data.table = FALSE, colClasses = "character") +scheme_admin_express_3_1 = data.table::fread( + "inst/extdata/scheme_admin_express_3_1.csv", + data.table = FALSE, + colClasses = "character" +) scheme_admin_express_3_1[["keep"]] = as.logical(scheme_admin_express_3_1[["keep"]]) Encoding(scheme_admin_express_3_1[["label_fr"]]) = "UTF-8" Encoding(scheme_admin_express_3_1[["comment"]]) = "UTF-8" usethis::use_data(scheme_admin_express_3_1, overwrite = TRUE) -scheme_ban = - data.table::fread("inst/extdata/scheme_ban.csv", data.table = FALSE, colClasses = "character") +scheme_ban = data.table::fread( + "inst/extdata/scheme_ban.csv", + data.table = FALSE, + colClasses = "character" +) scheme_ban[["keep"]] = as.logical(scheme_ban[["keep"]]) Encoding(scheme_ban[["label_fr"]]) = "UTF-8" Encoding(scheme_ban[["comment"]]) = "UTF-8" usethis::use_data(scheme_ban, overwrite = TRUE) -scheme_bd_topo_3 = - data.table::fread("inst/extdata/scheme_bd_topo_3.csv", data.table = FALSE, colClasses = "character") +scheme_bd_topo_3 = data.table::fread( + "inst/extdata/scheme_bd_topo_3.csv", + data.table = FALSE, + colClasses = "character" +) scheme_bd_topo_3[["keep"]] = as.logical(scheme_bd_topo_3[["keep"]]) Encoding(scheme_bd_topo_3[["label_fr"]]) = "UTF-8" Encoding(scheme_bd_topo_3[["comment"]]) = "UTF-8" usethis::use_data(scheme_bd_topo_3, overwrite = TRUE) -scheme_gaspar_azi = - data.table::fread("inst/extdata/scheme_gaspar_catnat.csv", data.table = FALSE, colClasses = "character") +scheme_gaspar_azi = data.table::fread( + "inst/extdata/scheme_gaspar_catnat.csv", + data.table = FALSE, + colClasses = "character" +) scheme_gaspar_azi[["keep"]] = as.logical(scheme_gaspar_azi[["keep"]]) Encoding(scheme_gaspar_azi[["label_fr"]]) = "UTF-8" Encoding(scheme_gaspar_azi[["comment"]]) = "UTF-8" usethis::use_data(scheme_gaspar_azi, overwrite = TRUE) -scheme_gaspar_catnat = - data.table::fread("inst/extdata/scheme_gaspar_catnat.csv", data.table = FALSE, colClasses = "character") +scheme_gaspar_catnat = data.table::fread( + "inst/extdata/scheme_gaspar_catnat.csv", + data.table = FALSE, + colClasses = "character" +) rownames(scheme_gaspar_catnat) = scheme_gaspar_catnat[["name"]] scheme_gaspar_catnat[["keep"]] = as.logical(scheme_gaspar_catnat[["keep"]]) Encoding(scheme_gaspar_catnat[["label_fr"]]) = "UTF-8" Encoding(scheme_gaspar_catnat[["comment"]]) = "UTF-8" usethis::use_data(scheme_gaspar_catnat, overwrite = TRUE) -scheme_gaspar_pprn = - data.table::fread("inst/extdata/scheme_gaspar_pprn.csv", data.table = FALSE, colClasses = "character") +scheme_gaspar_pprn = data.table::fread( + "inst/extdata/scheme_gaspar_pprn.csv", + data.table = FALSE, + colClasses = "character" +) scheme_gaspar_pprn[["keep"]] = as.logical(scheme_gaspar_pprn[["keep"]]) Encoding(scheme_gaspar_pprn[["label_fr"]]) = "UTF-8" Encoding(scheme_gaspar_pprn[["comment"]]) = "UTF-8" usethis::use_data(scheme_gaspar_pprn, overwrite = TRUE) -scheme_gaspar_risq = - data.table::fread("inst/extdata/scheme_gaspar_catnat.csv", data.table = FALSE, colClasses = "character") +scheme_gaspar_risq = data.table::fread( + "inst/extdata/scheme_gaspar_catnat.csv", + data.table = FALSE, + colClasses = "character" +) scheme_gaspar_risq[["keep"]] = as.logical(scheme_gaspar_risq[["keep"]]) Encoding(scheme_gaspar_risq[["label_fr"]]) = "UTF-8" Encoding(scheme_gaspar_risq[["comment"]]) = "UTF-8" usethis::use_data(scheme_gaspar_risq, overwrite = TRUE) -scheme_insee_logement_2019 = data.table::fread("inst/extdata/scheme_insee_logement_2019.csv", data.table = FALSE, - colClasses = "character", encoding = "UTF-8", stringsAsFactors = FALSE) +scheme_insee_logement_2019 = data.table::fread( + "inst/extdata/scheme_insee_logement_2019.csv", + data.table = FALSE, + colClasses = "character" +) scheme_insee_logement_2019[["keep"]] = as.logical(scheme_insee_logement_2019[["keep"]]) Encoding(scheme_insee_logement_2019[["label_fr"]]) = "UTF-8" Encoding(scheme_insee_logement_2019[["comment"]]) = "UTF-8" usethis::use_data(scheme_insee_logement_2019, overwrite = TRUE) -scheme_rpg_1 = data.table::fread("inst/extdata/scheme_rpg_1.csv", data.table = FALSE, colClasses = "character") +scheme_rpg_1 = data.table::fread( + "inst/extdata/scheme_rpg_1.csv", + data.table = FALSE, + colClasses = "character" +) rownames(scheme_rpg_1) = scheme_rpg_1[["name"]] Encoding(scheme_rpg_1[["label_fr"]]) = "UTF-8" Encoding(scheme_rpg_1[["comment"]]) = "UTF-8" usethis::use_data(scheme_rpg_1, overwrite = TRUE) -scheme_rpg_2 = data.table::fread("inst/extdata/scheme_rpg_2.csv", data.table = FALSE, colClasses = "character") +scheme_rpg_2 = data.table::fread( + "inst/extdata/scheme_rpg_2.csv", + data.table = FALSE, + colClasses = "character" +) rownames(scheme_rpg_2) = scheme_rpg_2[["name"]] Encoding(scheme_rpg_2[["label_fr"]]) = "UTF-8" Encoding(scheme_rpg_2[["comment"]]) = "UTF-8" usethis::use_data(scheme_rpg_2, overwrite = TRUE) -scheme_sirene_2019 = data.table::fread("inst/extdata/scheme_sirene_2019.csv", data.table = FALSE) +scheme_sirene_2019 = data.table::fread( + "inst/extdata/scheme_sirene_2019.csv", + data.table = FALSE +) Encoding(scheme_sirene_2019[["label.french"]]) = "UTF-8" Encoding(scheme_sirene_2019[["comment"]]) = "UTF-8" usethis::use_data(scheme_sirene_2019, overwrite = TRUE) -scheme_sirene_na = data.table::fread("inst/extdata/scheme_sirene_na.csv", data.table = FALSE) +scheme_sirene_na = data.table::fread( + "inst/extdata/scheme_sirene_na.csv", + data.table = FALSE +) usethis::use_data(scheme_sirene_na, overwrite = TRUE) -bd_topo_nature_reclass = - data.table::fread("inst/extdata/bd_topo_nature_reclass.csv", data.table = FALSE, - colClasses = "character", encoding = "UTF-8", stringsAsFactors = TRUE) +bd_topo_nature_reclass = data.table::fread( + "inst/extdata/bd_topo_nature_reclass.csv", + data.table = FALSE, + colClasses = "character", + encoding = "UTF-8", + stringsAsFactors = TRUE +) usethis::use_data(bd_topo_nature_reclass, overwrite = TRUE) -bd_topo_wall = data.table::fread("inst/extdata/bd_topo_wall.csv", data.table = FALSE, - colClasses = "character", encoding = "UTF-8", stringsAsFactors = TRUE) +bd_topo_wall = data.table::fread( + "inst/extdata/bd_topo_wall.csv", + data.table = FALSE, + colClasses = "character", + encoding = "UTF-8", + stringsAsFactors = TRUE +) usethis::use_data(bd_topo_wall, overwrite = TRUE) -bd_topo_roof = data.table::fread("inst/extdata/bd_topo_roof.csv", data.table = FALSE, - colClasses = "character", encoding = "UTF-8", stringsAsFactors = TRUE) +bd_topo_roof = data.table::fread( + "inst/extdata/bd_topo_roof.csv", + data.table = FALSE, + colClasses = "character", + encoding = "UTF-8", + stringsAsFactors = TRUE +) usethis::use_data(bd_topo_roof, overwrite = TRUE) setwd("..") diff --git a/data/nomenclature_clc.rda b/data/nomenclature_clc.rda new file mode 100644 index 0000000000000000000000000000000000000000..f659839819f2e5c2a8476dedc33a7cecf9b1c6d8 Binary files /dev/null and b/data/nomenclature_clc.rda differ diff --git a/dev/package.development.R b/dev/package.development.R index d7b51519f65ea1c993aeeeda357a0f43a09295c4..28aa968c4437a4aeec8d70cd493194a332f5e368 100644 --- a/dev/package.development.R +++ b/dev/package.development.R @@ -1,5 +1,5 @@ package = "floodam.data" ; devtools::document(package) ; devtools::load_all(package) - +sche ### Vignettes # setwd(package):usethis::use_vignette(package);setwd("..") devtools::build_vignettes(package) @@ -9,15 +9,10 @@ devtools::build_vignettes(package) ### Checks if (FALSE) { - { - # system("mv ~/.Rprofile ~/.Rprofile-temp") - devtools::check(package) - # Quand data.cquest ne répond pas... - devtools::check(package, args = c("--no-examples", "--no-tests")) - # system("mv ~/.Rprofile-temp ~/.Rprofile") - } + devtools::check(package) + # Quand data.cquest ne répond pas... + devtools::check(package, args = c("--no-examples", "--no-tests")) } -# ### Build devtools::build(package, path = "library", vignettes = TRUE) @@ -26,4 +21,4 @@ devtools::build(package, path = "library", vignettes = TRUE) # devtools::install_local(package) ### Site -pkgdown::build_site(package) \ No newline at end of file +pkgdown::build_site(package) diff --git a/dev/tag-message b/dev/tag-message index 8e24bb6c868127f859d980ba4d5b97b06f39542a..3069e8f8d73dc4adaa0b3144a003bb3afd52da07 100644 --- a/dev/tag-message +++ b/dev/tag-message @@ -1,123 +1,13 @@ -floodam.data Version: 0.9.35.0 +floodam.data Version: 0.9.36.0 0 errors ✔ | 0 warnings ✔ | 0 notes ✔ **Note de version** - * Amélioration de adapt_admin_express - * Remplace adapt.admin_express - * Utilisation du nouveau système de journal - * Utilisation de read_with_scheme pour lecture et mise en formatter - * Utilisation de save_archive pour sauvegarde y compris de façon - découpée - * paramètre export renommé en extension pour cohérence avec save_archive - * MaJ de la documentation - * Amélioration de analyse_archive - * fonction isolée et exportée - * traite les formats "IGN" et "floodam.data" - * fait des tests sur les sorties et renvoie des warnings - * test dans test_analyse_archive - * TO DO : intégrer les formats attendus dans une variable globale, hors - de la fonction - * Ajout de format_archive - * permet de créer des noms formattés des archives à partir - d'informations standardisées - * origin = "floodam.data" (défault) pour créer les noms des archives de - sauvegarde - * origin = "ign" pour créer les noms à la façon IGN (inverse de - analyse_archive) - * origin = "version" pour créer des patterns pour chercher dans les noms - façon IGN. - * tests dans test_format_archive - * Ajout de save_archive - * sauvegarde d'une archive de façon standardisée - * analyse le path pour trouver les informations (possibilité d'utiliser - l'option origin pour spécifier si origin = "floodam.data" ou origin = - "ign") - * extension peut-être écrasée par paramètre dédié - * gestion du scope (attention ça peut-être un facteur qui découpe - les données ou le nom d'une colonne dans cet input). - * extension gérée pour le moment: rds - * tests dans test_save_archive - * Amélioration de downlaod_archive - * renvoie un message si aucune archive n'est trouvée avec les options - demandées - * utilisation de add_journal_new au lieu de add_journal - * Amélioration de add_journal - * reprise de add_journal_new - * ancienne add_journal renommée temporairement en add_journal_old le - temps de la migration - * meilleure présentation des sous-tâches en introduisant le paramètre - degree - * Ajout de write_journal - * permet d'écrire un journal produit par add_journal_new soit au format - "csv", soit au format "log" en fonction de l'extension du fichier - * si aucun fichier n'est donné, le message au format "log" est affiché - sur la sortie standard - * si un fichier existant est donné, le journal est ajouté au précédent, - quelque soit le format choisi ("log" ou "csv") - * Non exportée - * Ajout de basename_core - * trouve le nom d'une archive en enlevant le path et les doubles - extensions de type .csv.gz ou .7z.001 notamment - * déploiement dans les fonctions - * tests dans test_basename_utilities - * Ajout de basename_ext - * trouve les extensions y compris les doubles de type .csv.gz ou .7z.001 - notamment - * déploiements dans les fonctions - * tests - * Ajout de format_journal - * permet de formatter un journal (ou une partie de journal) pour - préparer des messages au format "log" - * Non exportée - * Amélioration de read_with_scheme - * wrapper pour différentes fonctions plus spécifiques - * gère csv, csv.gz, shp, gpkg, shp from 7z, gpkg from 7z, zip - * pour zip, attention fait appel à une commande 'system' en modifiant - le nom du fichier pour faire une commande qui sera détectée par - data.table::fread, et présume que le format sera csv et pourra être lu - avec read_csv_with_scheme - * pour zip, modifie temporairemen l'option - 'datatable.fread.input.cmd.message' pour éviter le message renvoyé par - data.table::fread - * Ajout de read_csv_with_scheme - * correspond à ancienne version de read_with_scheme qui était csv - spécifique - * Ajout de read_gpkg_with_scheme - * gestion de gpkg avec scheme et projection - * Ajout de read_shp_with_scheme - * gestion de shp avec scheme et projection - * Amélioration de read_shp_from_7z - * Ancienne version n'était pas finalisée - * Extraction en fonction de la layer spécifiée - * Amélioration de read_gpkg_from_7z - * Séparation claire de la décompression et de la lecture - * Sécurité si plusieurs gpkg - * download_admin_express - * transformation de download.admin_express - * meilleure gestion des options (et match.arg) - * scheme_admin_express_3_1 (data) - * nouveau format à partir des infos IGN (version 3-1) - * style des noms des variables "." → "_" - * MaJ de data-raw/scheme.R et R/data.R pour intégration & documentation - * scheme_admin_express_2_0 (data) - * renommage de scheme_admin_express (data) qui ne faisait pas mention de - la version (version 2-0) - * style des noms des variables "." → "_" - * MaJ de data-raw/scheme.R et R/data.R pour intégration & documentation - * scheme_insee_2019 (data) - * renommage de certaines variables ('type_loge' en 'type', 'n_loge' en - 'dwelling', 'cat_loge' en 'usage') pour plus de cohérénces - * documentation - * corrections de coquilles (à la volée) pour les datasets - * regroupement des documentions pour fonction de la famille - read_with_scheme - * data.cquest.org - * toutes les mentions à l'adresse passent en https au lieu de http - * Roxygen - * utilisation de l'option markdown = TRUE (dans DESCIPTION) + * Ajout de nomenclature_clc + * Adaptation à pkgdwon 2.0.7 + **Détails** -# git tag -a v0.9.35.0 -F dev/tag-message +# git tag -a v0.9.36.0 -F dev/tag-message # git push --tags diff --git a/docs/404.html b/docs/404.html index c5aabd2b38195952f12080c64731ff835d1e14ad..7230b2b49e1b2be795afa71b56c4fd6b0dc4a559 100644 --- a/docs/404.html +++ b/docs/404.html @@ -39,7 +39,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -55,46 +55,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="articles/download-data.html">How to use floodam.data for downloads</a> + <a href="articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="articles/admin_express_fr.html">Admin express (French)</a> + <a href="admin_express_fr">Admin Express</a> </li> <li> - <a href="articles/ban_fr.html">BAN (French)</a> + <a href="articles/ban_fr.html">BAN</a> </li> <li> - <a href="articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="articles/gaspar_fr.html">gaspar (French)</a> + <a href="articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="articles/rpg_fr.html">rpg database</a> + <a href="articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="articles/index.html">More articles...</a> + <a href="articles/index.html">Other articles</a> </li> </ul> </li> @@ -138,7 +136,7 @@ Content not found. Please use links in the navbar. <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/admin_express_fr.html b/docs/articles/admin_express_fr.html index 73ffed22f76595ddef2c5f2101b36b77cde9b043..bc1ecc6f78a89e03dac64dc24fcd5d859b4cb680 100644 --- a/docs/articles/admin_express_fr.html +++ b/docs/articles/admin_express_fr.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -117,6 +115,7 @@ <div class="col-md-9 contents"> <div class="page-header toc-ignore"> <h1 data-toc-skip>Admin express (French)</h1> + <h4 data-toc-skip class="author">David Nortes Martinez</h4> <h4 data-toc-skip class="date">2023-01-27</h4> @@ -178,10 +177,10 @@ <p>La dernière source est un miroir de la première.</p> <p>La fonction <code><a href="../reference/download_admin_express.html">download_admin_express()</a></code> La fonction permet de télécharger la base de données, en premier lieu, à partir de la première adresse. En cas d’échec, la deuxième source de données est utilisée. Des sources alternatives peuvent être utilisées en fournissant des paramètres additionnels (voir aide de la fonction : <a href="http://www.floodam.org/floodam.data/reference/download.admin_express.html" class="external-link uri">http://www.floodam.org/floodam.data/reference/download.admin_express.html</a>).</p> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span> -<span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"admin_express"</span>, <span class="st">"download"</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span><span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></span> +<span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"admin_express"</span>, <span class="st">"download"</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span><span class="op">)</span></span></code></pre></div> </div> <div class="section level3"> <h3 id="traitement-de-la-base-de-données-admin-express">Traitement de la base de données ADMIN EXPRESS<a class="anchor" aria-label="anchor" href="#traitement-de-la-base-de-donn%C3%A9es-admin-express"></a> @@ -467,7 +466,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/ban_fr.html b/docs/articles/ban_fr.html index 1f941f331d97ab022596537e957172897c522b27..e520e1936fa123a3f3e138326ac1f6a0d38f37bf 100644 --- a/docs/articles/ban_fr.html +++ b/docs/articles/ban_fr.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -175,7 +173,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/bd_topo_dwelling_en.html b/docs/articles/bd_topo_dwelling_en.html index 16b3081cd598b46275356caf0e6f6a47120452b1..df481797461da7b64fa3b475d1f7e373fca6cf66 100644 --- a/docs/articles/bd_topo_dwelling_en.html +++ b/docs/articles/bd_topo_dwelling_en.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -127,7 +125,7 @@ <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></span></code></pre></div> <div class="section level2"> <h2 id="steps">Steps<a class="anchor" aria-label="anchor" href="#steps"></a> </h2> @@ -159,7 +157,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/bd_topo_en.html b/docs/articles/bd_topo_en.html index e0ea166a11a798e752c5e23829d0f8e44c7824eb..917fb88843156a7238b3ca602b39cee9cb70fe70 100644 --- a/docs/articles/bd_topo_en.html +++ b/docs/articles/bd_topo_en.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -166,11 +164,11 @@ <p>The last source is a mirror of the first one.</p> <p>The download.bd_topo function downloads the database from the first address by default. However, the second address can be used by providing additional parameters (see function help: <a href="http://www.floodam.org/floodam.data/reference/download.bd_topo.html" class="external-link uri">http://www.floodam.org/floodam.data/reference/download.bd_topo.html</a>).</p> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span> -<span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"bd_topo"</span>, <span class="st">"download"</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2019-09-19"</span><span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></span> +<span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"bd_topo"</span>, <span class="st">"download"</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2019-09-19"</span><span class="op">)</span></span></code></pre></div> </div> <div class="section level3"> <h3 id="data-adaptation">Data adaptation<a class="anchor" aria-label="anchor" href="#data-adaptation"></a> @@ -566,7 +564,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/bd_topo_fr.html b/docs/articles/bd_topo_fr.html index 155841801d8323cf8c13b648b55ea84117a5e2ea..f1601516ed7e2d601ae7ad6022294111f737cb29 100644 --- a/docs/articles/bd_topo_fr.html +++ b/docs/articles/bd_topo_fr.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -166,11 +164,11 @@ <p>La dernière source est un miroir de la première.</p> <p>La fonction download.bd_topo télécharge par défaut la base de données depuis la première adresse. Cependant, la seconde adresse peut être utilisée en fournissant des paramètres additionnels (voir aide de la fonction : <a href="http://www.floodam.org/floodam.data/reference/download.bd_topo.html" class="external-link uri">http://www.floodam.org/floodam.data/reference/download.bd_topo.html</a>).</p> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span> -<span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"bd_topo"</span>, <span class="st">"download"</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span> -<span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2019-09-19"</span><span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></span> +<span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"bd_topo"</span>, <span class="st">"download"</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span></span> +<span><span class="fu">download.bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2019-09-19"</span><span class="op">)</span></span></code></pre></div> </div> <div class="section level3"> <h3 id="adaptation-des-données">Adaptation des données<a class="anchor" aria-label="anchor" href="#adaptation-des-donn%C3%A9es"></a> @@ -566,7 +564,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/download-data.html b/docs/articles/download-data.html index 6b17908b171d9ebd51e6429582a066f940f3bbd6..6fbaa392e4deb015288cd8451247ca25a27d5260 100644 --- a/docs/articles/download-data.html +++ b/docs/articles/download-data.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -119,7 +117,7 @@ <h1 data-toc-skip>How to use floodam.data for downloads</h1> <h4 data-toc-skip class="author">Frédéric Grelot</h4> - <h4 data-toc-skip class="date">2023-03-27</h4> + <h4 data-toc-skip class="date">2023-05-02</h4> <div class="hidden name"><code>download-data.Rmd</code></div> @@ -168,7 +166,7 @@ <h2 id="general-considerations-on-floodam-data">General considerations on floodam.data<a class="anchor" aria-label="anchor" href="#general-considerations-on-floodam-data"></a> </h2> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></span></code></pre></div> <p>Typically <strong>floodam.data</strong> functions use two types of indications:</p> <ul> <li><p>where are located the data to be downloaded, this is specified by the parameter <em>origin</em></p></li> @@ -176,30 +174,30 @@ </ul> <p>It is a good idea to give some general indications for <em>origin</em> and <em>destination</em> that are specified more precisely when a specific call is made to a download function.</p> <div class="sourceCode" id="cb2"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="va">origin</span> <span class="op">=</span> <span class="st">"http://data.cquest.org"</span> -<span class="va">destination</span> <span class="op">=</span> <span class="st">"temp/floodam-data/original"</span></code></pre></div> +<code class="sourceCode R"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"http://data.cquest.org"</span></span> +<span><span class="va">destination</span> <span class="op">=</span> <span class="st">"temp/floodam-data/original"</span></span></code></pre></div> </div> <div class="section level2"> <h2 id="downloading-data-of-type-rpg">Downloading data of type “rpgâ€<a class="anchor" aria-label="anchor" href="#downloading-data-of-type-rpg"></a> </h2> <p><strong>rpg</strong> stands for <strong>registre parcellaire graphique</strong>. Those data are maintained by the French Minsitry of Agriculture.</p> <div class="sourceCode" id="cb3"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span> - origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"registre_parcellaire_graphique"</span><span class="op">)</span>, - destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">destination</span>, <span class="st">"rpg"</span><span class="op">)</span>, - year <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/character.html" class="external-link">as.character</a></span><span class="op">(</span><span class="fl">2010</span><span class="op">:</span><span class="fl">2018</span><span class="op">)</span> -<span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span></span> +<span> origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"registre_parcellaire_graphique"</span><span class="op">)</span>,</span> +<span> destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">destination</span>, <span class="st">"rpg"</span><span class="op">)</span>,</span> +<span> year <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/character.html" class="external-link">as.character</a></span><span class="op">(</span><span class="fl">2010</span><span class="op">:</span><span class="fl">2018</span><span class="op">)</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div class="section level2"> <h2 id="downloading-data-of-type-sirene">Downloading data of type “sireneâ€<a class="anchor" aria-label="anchor" href="#downloading-data-of-type-sirene"></a> </h2> <p><strong>sirene</strong> stands for <strong>Sirene</strong>. Those data are maintained by INSEE. They are processed by cquest to have information on localization.</p> <div class="sourceCode" id="cb4"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="fu"><a href="../reference/download.geo_sirene.html">download.geo_sirene</a></span><span class="op">(</span> - origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"geo_sirene"</span><span class="op">)</span>, - destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">destination</span>, <span class="st">"sirene"</span><span class="op">)</span>, - month <span class="op">=</span> <span class="fu">create.month</span><span class="op">(</span><span class="st">"2018-10"</span>, <span class="st">"2020-03"</span><span class="op">)</span> -<span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="fu"><a href="../reference/download.geo_sirene.html">download.geo_sirene</a></span><span class="op">(</span></span> +<span> origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"geo_sirene"</span><span class="op">)</span>,</span> +<span> destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">destination</span>, <span class="st">"sirene"</span><span class="op">)</span>,</span> +<span> month <span class="op">=</span> <span class="fu">create.month</span><span class="op">(</span><span class="st">"2018-10"</span>, <span class="st">"2020-03"</span><span class="op">)</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> </div> @@ -220,7 +218,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/gaspar_fr.html b/docs/articles/gaspar_fr.html index 34edb10c0264bfde4b0ce1d85f9deb1a5ab9efbf..216247f4ab99f4427b8ff0c9b12ccc91045434e4 100644 --- a/docs/articles/gaspar_fr.html +++ b/docs/articles/gaspar_fr.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -204,8 +202,8 @@ </tbody> </table> <p>Le type de risque (“num_risque_jo†dans la nomemclature d’oririgine et ‘catnat’ dans la nomenclature après traitement) est codifié selon les deux premières colonnes du tableau @ref(tab:catnat-classification). La variable ‘catnat’ correspond à la codification du type de risque utilisé lors de la publication dans le journal officiel.</p> -<div class="datatables html-widget html-fill-item-overflow-hidden html-fill-item" id="htmlwidget-d0646c7b7a759fe6a215" style="width:100%;height:auto;"></div> -<script type="application/json" data-for="htmlwidget-d0646c7b7a759fe6a215">{"x":{"filter":"none","vertical":false,"caption":"<caption>Classification des événements pour le thème catnat<\/caption>","data":[["ALS","AVA","CMV","COB","DIV","ECB","EFA","VOL","GLT","GER","GET","GRL","ICB","IRN","LVT","MVT","PDN","RAZ","SEC","SEI","TMP","VCY"],["Algues Sargasses","Avalanche","Chocs Mécaniques liés à l'action des Vagues","Coulée de Boue","Divers","Eboulement et/ou Chute de Blocs","Effondrement et/ou Affaisement","Eruption Volcanique","Glissement de Terrain","Glissement et Eboulement Rocheux","Glissement et Effondrement de Terrain","Grêle","Inondations et/ou Coulées de Boue","Inondations Remontée Nappe","Lave Torrentielle","Mouvement de Terrain","Poids de la Neige","Raz de Marée","Sécheresse","Secousse Sismique","Tempête","Vents Cycloniques"],[false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false],[false,false,false,true,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false],[false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false]],"container":"<table class=\"display\">\n <thead>\n <tr>\n <th>catnat<\/th>\n <th>catnat_label_fr<\/th>\n <th>flooding<\/th>\n <th>mudslide<\/th>\n <th>water_table<\/th>\n <th>torrential<\/th>\n <th>submersion<\/th>\n <th>hurricane<\/th>\n <\/tr>\n <\/thead>\n<\/table>","options":{"dom":"tip","columnDefs":[],"order":[],"autoWidth":false,"orderClasses":false}},"evals":[],"jsHooks":[]}</script> +<div class="datatables html-widget html-fill-item-overflow-hidden html-fill-item" id="htmlwidget-d51d0f48751e6e3d5dee" style="width:100%;height:auto;"></div> +<script type="application/json" data-for="htmlwidget-d51d0f48751e6e3d5dee">{"x":{"filter":"none","vertical":false,"caption":"<caption>Classification des événements pour le thème catnat<\/caption>","data":[["ALS","AVA","CMV","COB","DIV","ECB","EFA","VOL","GLT","GER","GET","GRL","ICB","IRN","LVT","MVT","PDN","RAZ","SEC","SEI","TMP","VCY"],["Algues Sargasses","Avalanche","Chocs Mécaniques liés à l'action des Vagues","Coulée de Boue","Divers","Eboulement et/ou Chute de Blocs","Effondrement et/ou Affaisement","Eruption Volcanique","Glissement de Terrain","Glissement et Eboulement Rocheux","Glissement et Effondrement de Terrain","Grêle","Inondations et/ou Coulées de Boue","Inondations Remontée Nappe","Lave Torrentielle","Mouvement de Terrain","Poids de la Neige","Raz de Marée","Sécheresse","Secousse Sismique","Tempête","Vents Cycloniques"],[false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false],[false,false,false,true,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false],[false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false]],"container":"<table class=\"display\">\n <thead>\n <tr>\n <th>catnat<\/th>\n <th>catnat_label_fr<\/th>\n <th>flooding<\/th>\n <th>mudslide<\/th>\n <th>water_table<\/th>\n <th>torrential<\/th>\n <th>submersion<\/th>\n <th>hurricane<\/th>\n <\/tr>\n <\/thead>\n<\/table>","options":{"dom":"tip","columnDefs":[],"order":[],"autoWidth":false,"orderClasses":false}},"evals":[],"jsHooks":[]}</script> </div> <div class="section level3"> <h3 id="thème-pprn">Thème “pprnâ€<a class="anchor" aria-label="anchor" href="#th%C3%A8me-pprn"></a> @@ -571,8 +569,8 @@ date de mise à jour de la fiche gaspar </tbody> </table> <p>Le type de risque (“num_risque†dans la nomemclature d’oririgine et “hazard†dans la nomenclature après traitement) est codifié selon les deux premières colonnes du tableau @ref(tab:pprn-classification).</p> -<div class="datatables html-widget html-fill-item-overflow-hidden html-fill-item" id="htmlwidget-115532d36ad92ce59d8f" style="width:100%;height:auto;"></div> -<script type="application/json" data-for="htmlwidget-115532d36ad92ce59d8f">{"x":{"filter":"none","vertical":false,"caption":"<caption>Classification des événements pour le thème pprn<\/caption>","data":[["180","140","134","143","183","147","130","285","135","157","158","159","166","131","286","152","153","194","195","288","252","129","160","168","167"],["Par une crue à débordement lent de cours d'eau","Inondation","Mouvement de terrain","Eboulement ou chutes de pierres et de blocs","Par une crue torrentielle ou à montée rapide de cours d'eau","Glissement de terrain","Par ruissellement et coulée de boue","Par remontées de nappes naturelles","Affaissements et effondrements (cavités souterraines hors mines)","Tassements différentiels","Séisme","Avalanche","Feu de forêt","Par lave torrentielle (torrent et talweg)","Par submersion marine","Avancée dunaire","Recul du trait de côte et de falaises","Zones marécageuses","Suffosion","Glissements ou mouvements de pente","Effondrements généralisés","Risques naturels","Eruption volcanique","Cyclone/ouragan (vent)","Phénomène lié à l'atmosphère"],[true,true,false,false,false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,true,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,true,false]],"container":"<table class=\"display\">\n <thead>\n <tr>\n <th>hazard<\/th>\n <th>hazard_label_fr<\/th>\n <th>flooding<\/th>\n <th>mudslide<\/th>\n <th>water_table<\/th>\n <th>torrential<\/th>\n <th>submersion<\/th>\n <th>hurricane<\/th>\n <\/tr>\n <\/thead>\n<\/table>","options":{"dom":"tip","columnDefs":[],"order":[],"autoWidth":false,"orderClasses":false}},"evals":[],"jsHooks":[]}</script> +<div class="datatables html-widget html-fill-item-overflow-hidden html-fill-item" id="htmlwidget-ae792f292dc8e74a29b8" style="width:100%;height:auto;"></div> +<script type="application/json" data-for="htmlwidget-ae792f292dc8e74a29b8">{"x":{"filter":"none","vertical":false,"caption":"<caption>Classification des événements pour le thème pprn<\/caption>","data":[["180","140","134","143","183","147","130","285","135","157","158","159","166","131","286","152","153","194","195","288","252","129","160","168","167"],["Par une crue à débordement lent de cours d'eau","Inondation","Mouvement de terrain","Eboulement ou chutes de pierres et de blocs","Par une crue torrentielle ou à montée rapide de cours d'eau","Glissement de terrain","Par ruissellement et coulée de boue","Par remontées de nappes naturelles","Affaissements et effondrements (cavités souterraines hors mines)","Tassements différentiels","Séisme","Avalanche","Feu de forêt","Par lave torrentielle (torrent et talweg)","Par submersion marine","Avancée dunaire","Recul du trait de côte et de falaises","Zones marécageuses","Suffosion","Glissements ou mouvements de pente","Effondrements généralisés","Risques naturels","Eruption volcanique","Cyclone/ouragan (vent)","Phénomène lié à l'atmosphère"],[true,true,false,false,false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,true,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,false,false,false,false,false,true,false,false,false],[false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,true,false,true,false]],"container":"<table class=\"display\">\n <thead>\n <tr>\n <th>hazard<\/th>\n <th>hazard_label_fr<\/th>\n <th>flooding<\/th>\n <th>mudslide<\/th>\n <th>water_table<\/th>\n <th>torrential<\/th>\n <th>submersion<\/th>\n <th>hurricane<\/th>\n <\/tr>\n <\/thead>\n<\/table>","options":{"dom":"tip","columnDefs":[],"order":[],"autoWidth":false,"orderClasses":false}},"evals":[],"jsHooks":[]}</script> </div> </div> <div class="section level2"> @@ -609,12 +607,12 @@ date de mise à jour de la fiche gaspar <p>Les deux dernières sources sont des miroirs de la première.</p> <p>La fonction download_gapsar permet d’accéder à chacune de ces trois sources en utilisant le paramètre “originâ€.</p> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span> -<span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"gaspar"</span>, <span class="st">"download"</span><span class="op">)</span> -<span class="fu"><a href="../reference/download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> -<span class="fu"><a href="../reference/download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span><span class="op">)</span> -<span class="fu"><a href="../reference/download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"opendatarchives"</span><span class="op">)</span></code></pre></div> -<p>Comme il n’y aucune indication de la version de la base de donnée téléchargée, le téléchargement se fait dans un sous-dossier du chemin indiqué dans le paramètre “destination†indiquant le jour du téléchargement. Les téléchargements du chunk précédent auraient par exemple été réalisés dans le dossier gaspar/download/2023-03-27.</p> +<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va">floodam.data</span><span class="op">)</span></span> +<span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"gaspar"</span>, <span class="st">"download"</span><span class="op">)</span></span> +<span><span class="fu"><a href="../reference/download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> +<span><span class="fu"><a href="../reference/download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span><span class="op">)</span></span> +<span><span class="fu"><a href="../reference/download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"opendatarchives"</span><span class="op">)</span></span></code></pre></div> +<p>Comme il n’y aucune indication de la version de la base de donnée téléchargée, le téléchargement se fait dans un sous-dossier du chemin indiqué dans le paramètre “destination†indiquant le jour du téléchargement. Les téléchargements du chunk précédent auraient par exemple été réalisés dans le dossier gaspar/download/2023-05-02.</p> </div> <div class="section level3"> <h3 id="adaptation-des-données">Adaptation des données<a class="anchor" aria-label="anchor" href="#adaptation-des-donn%C3%A9es"></a> @@ -822,7 +820,7 @@ date <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/articles/index.html b/docs/articles/index.html index d063a1452e4fde6693f3088bfbff7405ac1c0795..c972a9d8fdd2f1f20555ae77851648034de0fb59 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -84,41 +83,26 @@ </div> <div class="section "> - <h3>Introduction to the library</h3> + <h3>All vignettes</h3> <p class="section-desc"></p> - <dl><dt><a href="download-data.html">How to use floodam.data for downloads</a></dt> - <dd> - </dd></dl></div> - <div class="section "> - <h3>database (English)</h3> - <p class="section-desc"></p><p>Description of database managed</p> - - <dl><dt><a href="bd_topo_en.html">BD Topo</a></dt> - <dd> - </dd></dl></div> - <div class="section "> - <h3>database (French)</h3> - <p class="section-desc"></p><p>French description of database managed</p> - <dl><dt><a href="admin_express_fr.html">Admin express (French)</a></dt> <dd> </dd><dt><a href="ban_fr.html">BAN (French)</a></dt> <dd> + </dd><dt><a href="bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a></dt> + <dd> + </dd><dt><a href="bd_topo_en.html">BD Topo</a></dt> + <dd> </dd><dt><a href="bd_topo_fr.html">BD Topo (French)</a></dt> <dd> + </dd><dt><a href="download-data.html">How to use floodam.data for downloads</a></dt> + <dd> </dd><dt><a href="gaspar_fr.html">gaspar (French)</a></dt> <dd> </dd><dt><a href="rpg_fr.html">rpg database</a></dt> <dd> </dd></dl></div> - <div class="section "> - <h3>Processes (English)</h3> - <p class="section-desc"></p><p>Description of some processes</p> - - <dl><dt><a href="bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a></dt> - <dd> - </dd></dl></div> </div> </div> @@ -128,7 +112,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/articles/rpg_fr.html b/docs/articles/rpg_fr.html index 288a19d3e9eb0cd17734d7112152e9f84419d3b0..f98fd6a9e2557778a8e41de37b1aab0109280955 100644 --- a/docs/articles/rpg_fr.html +++ b/docs/articles/rpg_fr.html @@ -40,7 +40,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -56,46 +56,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul> </li> @@ -253,10 +251,10 @@ <p>Tous les fichiers téléchargeables de chaque millésimes sont disponibles au format Shapefile à l’exception de la France métropolitaine qui est uniquement disponible au format Geopackage depuis 2019. En 2019 la France métropolitaine est aussi disponible au format SQL.</p> <p>La fonction download_rpg permet d’accéder à chacune de ces deux sources en utilisant le paramètre ‘origin’ et de choisir le millésime en utilisant le paramètre ‘year’.</p> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> -<code class="sourceCode R"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"rpg"</span>, <span class="st">"download"</span><span class="op">)</span> -<span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> -<span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span>, year <span class="op">=</span> <span class="st">"2020"</span><span class="op">)</span> -<span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"IGN"</span>, year <span class="op">=</span> <span class="st">"2020"</span><span class="op">)</span></code></pre></div> +<code class="sourceCode R"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="st">"rpg"</span>, <span class="st">"download"</span><span class="op">)</span></span> +<span><span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> +<span><span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span>, year <span class="op">=</span> <span class="st">"2020"</span><span class="op">)</span></span> +<span><span class="fu"><a href="../reference/download.rpg.html">download.rpg</a></span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"IGN"</span>, year <span class="op">=</span> <span class="st">"2020"</span><span class="op">)</span></span></code></pre></div> </div> <div class="section level3"> <h3 id="adaptation-des-données">Adaptation des données<a class="anchor" aria-label="anchor" href="#adaptation-des-donn%C3%A9es"></a> @@ -481,7 +479,7 @@ character <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/authors.html b/docs/authors.html index 966f0798135083507d5ec1464d2b3e0292a8601c..6eb61139204d7ec8ae6029f32aa5bb81323b5472 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="articles/download-data.html">How to use floodam.data for downloads</a> + <a href="articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="articles/admin_express_fr.html">Admin express (French)</a> + <a href="admin_express_fr">Admin Express</a> </li> <li> - <a href="articles/ban_fr.html">BAN (French)</a> + <a href="articles/ban_fr.html">BAN</a> </li> <li> - <a href="articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="articles/gaspar_fr.html">gaspar (French)</a> + <a href="articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="articles/rpg_fr.html">rpg database</a> + <a href="articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="articles/index.html">More articles...</a> + <a href="articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -112,13 +111,13 @@ <p>Grelot F, Nortes Martinez D, Balzergue P, Champonnois V (2023). <em>floodam.data: Collect and Process Data on Flood Damage (French Context)</em>. -R package version 0.9.35.0. +R package version 0.9.36.0. </p> <pre>@Manual{, title = {floodam.data: Collect and Process Data on Flood Damage (French Context)}, author = {Frédéric Grelot and David {Nortes Martinez} and Pierre Balzergue and Victor Champonnois}, year = {2023}, - note = {R package version 0.9.35.0}, + note = {R package version 0.9.36.0}, }</pre> </div> @@ -132,7 +131,7 @@ R package version 0.9.35.0. </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/index.html b/docs/index.html index fedefae0d5669a5417d285ff913e360a3084a0d4..5c53924dc04e6d154abdf741f2dd61124d9960b2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -44,7 +44,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -60,46 +60,44 @@ <span class="caret"></span> </a> <ul class="dropdown-menu" role="menu"> -<li class="divider"> - </li> <li class="dropdown-header">Introduction</li> <li> - <a href="articles/download-data.html">How to use floodam.data for downloads</a> + <a href="articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (En)</li> +<li class="dropdown-header">database (English)</li> <li> <a href="articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> </li> -<li class="dropdown-header">database (Fr)</li> +<li class="dropdown-header">database (French)</li> <li> - <a href="articles/admin_express_fr.html">Admin express (French)</a> + <a href="admin_express_fr">Admin Express</a> </li> <li> - <a href="articles/ban_fr.html">BAN (French)</a> + <a href="articles/ban_fr.html">BAN</a> </li> <li> - <a href="articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="articles/gaspar_fr.html">gaspar (French)</a> + <a href="articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="articles/rpg_fr.html">rpg database</a> + <a href="articles/rpg_fr.html">RPG</a> </li> <li class="divider"> </li> -<li class="dropdown-header">Processes (En)</li> +<li class="dropdown-header">Processes (English)</li> <li> - <a href="articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> </li> <li> - <a href="articles/index.html">More articles...</a> + <a href="articles/index.html">Other articles</a> </li> </ul> </li> @@ -206,7 +204,7 @@ <div class="pkgdown"> <p></p> -<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> +<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer> diff --git a/docs/news/index.html b/docs/news/index.html index 6048c62891916f622a8d7fc3d1b2dd20a0f00857..2b6e0c122af6d9ba413ec32e1ca60ca007eb628d 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -185,7 +184,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 77f9b452f2f7810cda71db784434b9c2c0b82839..6f43cece24dffd85725dd5d5ebc7e4f4ee2a5ad5 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,5 +1,5 @@ pandoc: '2.5' -pkgdown: 2.0.3 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: admin_express_fr: admin_express_fr.html @@ -10,5 +10,5 @@ articles: download-data: download-data.html gaspar_fr: gaspar_fr.html rpg_fr: rpg_fr.html -last_built: 2023-03-27T11:51Z +last_built: 2023-05-02T05:58Z diff --git a/docs/reference/adapt.eaip.html b/docs/reference/adapt.eaip.html index d222a6dcdeeacf829b8ae983ec4b2973a5202eb1..24e5b4bf65abdc99c965c81c03d7192de63aa6f3 100644 --- a/docs/reference/adapt.eaip.html +++ b/docs/reference/adapt.eaip.html @@ -24,7 +24,7 @@ the output is saved at department level as rds in given destination </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -38,41 +38,40 @@ the output is saved at department level as rds in given destination <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -101,43 +100,62 @@ the output is saved at department level as rds in given destination </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">adapt.eaip</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">department</span>, - export <span class="op">=</span> <span class="st">"rds"</span>, - projection <span class="op">=</span> <span class="fl">4326</span>, - variable_common <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="eaip_variable.html">eaip_variable</a></span>, - validity <span class="op">=</span> <span class="cn">TRUE</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">FALSE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">adapt.eaip</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">department</span>,</span> +<span> export <span class="op">=</span> <span class="st">"rds"</span>,</span> +<span> projection <span class="op">=</span> <span class="fl">4326</span>,</span> +<span> variable_common <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="eaip_variable.html">eaip_variable</a></span>,</span> +<span> validity <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">FALSE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where eaip are stored</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved</p></dd> + + <dt>department</dt> <dd><p>vector, departments to be adpated</p></dd> + + <dt>export</dt> <dd><p>character, option for export format of the results</p></dd> + + <dt>projection</dt> <dd><p>integer or object of type CRS giving projection</p></dd> + + <dt>variable_common</dt> <dd><p>character, what are the variables that should be kept. Best to leave it to default or NULL.</p></dd> + + <dt>validity</dt> <dd><p>logical, should st_make_valid be applied (may be very long).</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, sf object representing eaip for asked departments.</p> + + +<p>if retrieve = TRUE, sf object representing eaip for asked departments.</p> </div> <div id="author"> <h2>Author</h2> @@ -146,12 +164,12 @@ the output is saved at department level as rds in given destination <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"~/data/BD/EAIP/shp"</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">eaip_01</span> <span class="op">=</span> <span class="fu">adapt.eaip</span><span class="op">(</span><span class="va">origin</span>, <span class="va">destination</span>, department <span class="op">=</span> <span class="fl">1</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"~/data/BD/EAIP/shp"</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">eaip_01</span> <span class="op">=</span> <span class="fu">adapt.eaip</span><span class="op">(</span><span class="va">origin</span>, <span class="va">destination</span>, department <span class="op">=</span> <span class="fl">1</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -166,7 +184,7 @@ the output is saved at department level as rds in given destination </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/adapt.geo_sirene.html b/docs/reference/adapt.geo_sirene.html index 655bf8abab65853a103395545ed94f5a76ea1aae..00968062c5d52d489a537037c75ac7be5029bf42 100644 --- a/docs/reference/adapt.geo_sirene.html +++ b/docs/reference/adapt.geo_sirene.html @@ -25,7 +25,7 @@ Exposition of observations (belonging or not to eaip) is added. </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -39,41 +39,40 @@ Exposition of observations (belonging or not to eaip) is added. <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -103,50 +102,73 @@ Exposition of observations (belonging or not to eaip) is added. </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">adapt.geo_sirene</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - export <span class="op">=</span> <span class="st">"fst"</span>, - scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_sirene_2019.html">scheme_sirene_2019</a></span>, - na_value <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_sirene_na.html">scheme_sirene_na</a></span>, - eaip_path <span class="op">=</span> <span class="cn">NULL</span>, - projection <span class="op">=</span> <span class="fl">4326</span>, - order_by <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"state"</span>, <span class="st">"eaip"</span><span class="op">)</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">FALSE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">adapt.geo_sirene</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> export <span class="op">=</span> <span class="st">"fst"</span>,</span> +<span> scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_sirene_2019.html">scheme_sirene_2019</a></span>,</span> +<span> na_value <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_sirene_na.html">scheme_sirene_na</a></span>,</span> +<span> eaip_path <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> projection <span class="op">=</span> <span class="fl">4326</span>,</span> +<span> order_by <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"state"</span>, <span class="st">"eaip"</span><span class="op">)</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">FALSE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated</p></dd> + + <dt>export</dt> <dd><p>character, option for export format of the results</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, how archive variables should be treated</p></dd> + + <dt>na_value</dt> <dd><p>data.frame, list of NA values for each variables</p></dd> + + <dt>eaip_path</dt> <dd><p>character, path where eaip archives should be find</p></dd> + + <dt>projection</dt> <dd><p>optional numeric, 4 digits projection to use</p></dd> + + <dt>order_by</dt> <dd><p>optional character, name of the variable to sort the output data. Default sorting is by state and eaip (if added).</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -155,13 +177,13 @@ Default sorting is by state and eaip (if added).</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">""</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">archive</span> <span class="op">=</span> <span class="st">"geo_siret_34.csv.gz"</span></span> -<span class="r-in"><span class="va">result</span> <span class="op">=</span> <span class="fu">adapt.geo_sirene</span><span class="op">(</span><span class="va">origin</span>, <span class="va">destination</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">""</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">archive</span> <span class="op">=</span> <span class="st">"geo_siret_34.csv.gz"</span></span></span> +<span class="r-in"><span><span class="va">result</span> <span class="op">=</span> <span class="fu">adapt.geo_sirene</span><span class="op">(</span><span class="va">origin</span>, <span class="va">destination</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -176,7 +198,7 @@ Default sorting is by state and eaip (if added).</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/adapt_admin_express.html b/docs/reference/adapt_admin_express.html index 5872c09eec4eb37d1d7fc7c2ccb950367edb192b..ec233009b6e1526ad5bb968574eb420f6924f8d1 100644 --- a/docs/reference/adapt_admin_express.html +++ b/docs/reference/adapt_admin_express.html @@ -23,7 +23,7 @@ parameters are not specified."><meta property="og:image" content="/logo.png"><!- </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -37,41 +37,40 @@ parameters are not specified."><meta property="og:image" content="/logo.png"><!- <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -102,48 +101,69 @@ parameters are not specified.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">adapt_admin_express</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - layer <span class="op">=</span> <span class="cn">NULL</span>, - scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_admin_express_3_1.html">scheme_admin_express_3_1</a></span>, - projection <span class="op">=</span> <span class="fl">4326</span>, - extension <span class="op">=</span> <span class="st">"rds"</span>, - journal <span class="op">=</span> <span class="cn">TRUE</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">adapt_admin_express</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> layer <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_admin_express_3_1.html">scheme_admin_express_3_1</a></span>,</span> +<span> projection <span class="op">=</span> <span class="fl">4326</span>,</span> +<span> extension <span class="op">=</span> <span class="st">"rds"</span>,</span> +<span> journal <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved.</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated.</p></dd> + + <dt>layer</dt> <dd><p>character, which layer should be treated.</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, how archive variables should be treated.</p></dd> + + <dt>projection</dt> <dd><p>integer or object of type CRS giving projection.</p></dd> + + <dt>extension</dt> <dd><p>character, option for extension and so format of saving of results.</p></dd> + + <dt>journal</dt> <dd><p>logical, should a journal file be saved.</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, sf object of adapated data stored in archive. + + +<p>if retrieve = TRUE, sf object of adapated data stored in archive. This may be a list if the function implies recursive calls.</p> </div> <div id="details"> @@ -164,13 +184,13 @@ name of archive include a precision depending on the layer chosen. For layer <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">""</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">archive</span> <span class="op">=</span> <span class="st">"RPG_2-0__SHP_LAMB93_FR-2018_2018-01-15.7z"</span></span> -<span class="r-in"><span class="va">result</span> <span class="op">=</span> <span class="fu"><a href="adapt_rpg.html">adapt_rpg</a></span><span class="op">(</span><span class="va">archive</span>, <span class="va">origin</span>, <span class="va">destination</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">""</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">archive</span> <span class="op">=</span> <span class="st">"RPG_2-0__SHP_LAMB93_FR-2018_2018-01-15.7z"</span></span></span> +<span class="r-in"><span><span class="va">result</span> <span class="op">=</span> <span class="fu"><a href="adapt_rpg.html">adapt_rpg</a></span><span class="op">(</span><span class="va">archive</span>, <span class="va">origin</span>, <span class="va">destination</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -185,7 +205,7 @@ name of archive include a precision depending on the layer chosen. For layer </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/adapt_ban.html b/docs/reference/adapt_ban.html index d70feb9b701762ae7b05e32b7dd5d33176f21e09..a7cf6ef4e092a1c5548d1fa2b0227863e71e6d58 100644 --- a/docs/reference/adapt_ban.html +++ b/docs/reference/adapt_ban.html @@ -22,7 +22,7 @@ if scope is given, a subpart of data is also saved. </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -36,41 +36,40 @@ if scope is given, a subpart of data is also saved. <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -97,49 +96,72 @@ if scope is given, a subpart of data is also saved. </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">adapt_ban</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_ban.html">scheme_ban</a></span>, - projection <span class="op">=</span> <span class="fl">4326</span>, - path_eaip <span class="op">=</span> <span class="cn">NULL</span>, - path_admin <span class="op">=</span> <span class="cn">NULL</span>, - map <span class="op">=</span> <span class="cn">FALSE</span>, - journal <span class="op">=</span> <span class="cn">TRUE</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">adapt_ban</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_ban.html">scheme_ban</a></span>,</span> +<span> projection <span class="op">=</span> <span class="fl">4326</span>,</span> +<span> path_eaip <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> path_admin <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> map <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> journal <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved.</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated.</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, how archive variables should be treated.</p></dd> + + <dt>projection</dt> <dd><p>numeric, 4 digits projection to use.</p></dd> + + <dt>path_eaip</dt> <dd><p>character, path where eaip archives should be found.</p></dd> + + <dt>path_admin</dt> <dd><p>character, path where admin archives should be found.</p></dd> + + <dt>map</dt> <dd><p>logical, should a map be plotted (for check purpose).</p></dd> + + <dt>journal</dt> <dd><p>logical, should a journal file be saved.</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -158,7 +180,7 @@ if scope is given, a subpart of data is also saved. </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/adapt_gaspar.html b/docs/reference/adapt_gaspar.html index 4fe22471de8235b1b55a034f8094fcf75ca58b92..565d5f91ae8e302ce619970927c1b73839cbb66a 100644 --- a/docs/reference/adapt_gaspar.html +++ b/docs/reference/adapt_gaspar.html @@ -22,7 +22,7 @@ if scope is given, a subpart of data is also saved </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -36,41 +36,40 @@ if scope is given, a subpart of data is also saved <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -97,47 +96,68 @@ if scope is given, a subpart of data is also saved </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">adapt_gaspar</span><span class="op">(</span> - <span class="va">origin</span>, - destination <span class="op">=</span> <span class="va">origin</span>, - archive <span class="op">=</span> <span class="st">"gaspar.zip"</span>, - theme <span class="op">=</span> <span class="st">"catnat"</span>, - <span class="va">version</span>, - scope <span class="op">=</span> <span class="cn">NULL</span>, - export <span class="op">=</span> <span class="st">"rds"</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - keep <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">adapt_gaspar</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> destination <span class="op">=</span> <span class="va">origin</span>,</span> +<span> archive <span class="op">=</span> <span class="st">"gaspar.zip"</span>,</span> +<span> theme <span class="op">=</span> <span class="st">"catnat"</span>,</span> +<span> <span class="va">version</span>,</span> +<span> scope <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> export <span class="op">=</span> <span class="st">"rds"</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> keep <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated</p></dd> + + <dt>theme</dt> <dd><p>character, name of the theme to be treated</p></dd> + + <dt>version</dt> <dd><p>character, version of data to be treated. If missing, version is guessed from folders in origin.</p></dd> + + <dt>scope</dt> <dd><p>list, named list of scope (vector of commune)</p></dd> + + <dt>export</dt> <dd><p>character, option for export format of the results</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned</p></dd> + + <dt>keep</dt> <dd><p>logical, should the original data be kept. Default to FALSE.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations. Default to TRUE.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -146,12 +166,12 @@ is guessed from folders in origin.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"data-local/georisques/gaspar"</span></span> -<span class="r-in"><span class="fu">adapt_gaspar</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">adapt_gaspar</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"2022-02-28"</span><span class="op">)</span>, scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"so_ii"</span> <span class="op">=</span> <span class="fu">so.ii</span><span class="fu">::</span><span class="va"><a href="https://rdrr.io/pkg/so.ii/man/so_ii_scope.html" class="external-link">so_ii_scope</a></span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"data-local/georisques/gaspar"</span></span></span> +<span class="r-in"><span><span class="fu">adapt_gaspar</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">adapt_gaspar</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"2022-02-28"</span><span class="op">)</span>, scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"so_ii"</span> <span class="op">=</span> <span class="fu">so.ii</span><span class="fu">::</span><span class="va">so_ii_scope</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -166,7 +186,7 @@ is guessed from folders in origin.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/adapt_rpg.html b/docs/reference/adapt_rpg.html index ec019e7adf43dac33cffdd1309b1a4b5ec85ad33..169118ec0de84f9720605775e2eb159604923496 100644 --- a/docs/reference/adapt_rpg.html +++ b/docs/reference/adapt_rpg.html @@ -23,7 +23,7 @@ the output is saved at department level as rds in given destination </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -37,41 +37,40 @@ the output is saved at department level as rds in given destination <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -99,49 +98,72 @@ the output is saved at department level as rds in given destination </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">adapt_rpg</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - export <span class="op">=</span> <span class="st">"rds"</span>, - scheme <span class="op">=</span> <span class="cn">NULL</span>, - department <span class="op">=</span> <span class="cn">NULL</span>, - dep_path <span class="op">=</span> <span class="cn">NULL</span>, - eaip_path <span class="op">=</span> <span class="cn">NULL</span>, - projection <span class="op">=</span> <span class="fl">4326</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">FALSE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">adapt_rpg</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> export <span class="op">=</span> <span class="st">"rds"</span>,</span> +<span> scheme <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> department <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> dep_path <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> eaip_path <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> projection <span class="op">=</span> <span class="fl">4326</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">FALSE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated</p></dd> + + <dt>export</dt> <dd><p>character, option for export format of the results</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, how archive variables should be treated</p></dd> + + <dt>department</dt> <dd><p>character, vector of department that should be treated</p></dd> + + <dt>dep_path</dt> <dd><p>character, path to the directory where departments data are stored</p></dd> + + <dt>eaip_path</dt> <dd><p>character, path where eaip archives should be find</p></dd> + + <dt>projection</dt> <dd><p>integer or object of type CRS giving projection</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, sf object of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, sf object of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -150,13 +172,13 @@ the output is saved at department level as rds in given destination <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">""</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">archive</span> <span class="op">=</span> <span class="st">"RPG_2-0__SHP_LAMB93_FR-2018_2018-01-15.7z"</span></span> -<span class="r-in"><span class="va">result</span> <span class="op">=</span> <span class="fu">adapt_rpg</span><span class="op">(</span><span class="va">archive</span>, <span class="va">origin</span>, <span class="va">destination</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">""</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">archive</span> <span class="op">=</span> <span class="st">"RPG_2-0__SHP_LAMB93_FR-2018_2018-01-15.7z"</span></span></span> +<span class="r-in"><span><span class="va">result</span> <span class="op">=</span> <span class="fu">adapt_rpg</span><span class="op">(</span><span class="va">archive</span>, <span class="va">origin</span>, <span class="va">destination</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, retrieve <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -171,7 +193,7 @@ the output is saved at department level as rds in given destination </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/add_commune.html b/docs/reference/add_commune.html index dc5eba51e12362caa704156700659f61da73c111..89cad88938fc367f099814b651a691b53f64a223 100644 --- a/docs/reference/add_commune.html +++ b/docs/reference/add_commune.html @@ -20,7 +20,7 @@ intersects more than one commune, one is chosen (more or less randomously)."><me </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -34,41 +34,40 @@ intersects more than one commune, one is chosen (more or less randomously)."><me <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -96,21 +95,28 @@ intersects more than one commune, one is chosen (more or less randomously).</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">add_commune</span><span class="op">(</span><span class="va">x</span>, <span class="va">commune</span>, department <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">add_commune</span><span class="op">(</span><span class="va">x</span>, <span class="va">commune</span>, department <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>sf object.</p></dd> + + <dt>commune</dt> <dd><p>sf object, that describes the commune perimeters.</p></dd> + + <dt>department</dt> <dd><p>character, department that should be used.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>sf object with both commune and department information added.</p> + + +<p>sf object with both commune and department information added.</p> </div> <div id="author"> <h2>Author</h2> @@ -129,7 +135,7 @@ intersects more than one commune, one is chosen (more or less randomously).</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/add_journal.html b/docs/reference/add_journal.html index 0b03b04928461301bddf44314d3c2ced2324f269..1f88be83cc18fbb8d3381da4b24229af4093f863 100644 --- a/docs/reference/add_journal.html +++ b/docs/reference/add_journal.html @@ -20,7 +20,7 @@ verbose is set to TRUE)."><meta property="og:image" content="/logo.png"><!-- mat </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -34,41 +34,40 @@ verbose is set to TRUE)."><meta property="og:image" content="/logo.png"><!-- mat <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -96,7 +95,7 @@ verbose is set to TRUE).</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, <span class="va">task</span>, <span class="va">status</span>, <span class="va">id</span>, degree <span class="op">=</span> <span class="fl">0</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, <span class="va">task</span>, <span class="va">status</span>, <span class="va">id</span>, degree <span class="op">=</span> <span class="fl">0</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> @@ -104,23 +103,36 @@ verbose is set to TRUE).</p> <dl><dt>journal</dt> <dd><p>data.frame, journal to be amended. May be missing (see details).</p></dd> + + <dt>task</dt> <dd><p>character, description of the task. May be missing (see details).</p></dd> + + <dt>status</dt> <dd><p>character, description of how the task has been performed. May be missing (see details).</p></dd> + + <dt>id</dt> <dd><p>integer, row of the task to be amended. May be missing (see details).</p></dd> + + <dt>degree</dt> <dd><p>integer, indicates how deep is the task</p></dd> + + <dt>verbose</dt> <dd><p>logical, should a message be sent. Default to TRUE.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>a data frame of journal information.</p> + + +<p>a data frame of journal information.</p> </div> <div id="details"> <h2>Details</h2> @@ -151,56 +163,56 @@ formatted by <code>floodam.date:::format_journal</code>.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="fu">add_journal</span><span class="op">(</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">add_journal</span><span class="op">(</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] task status start end elapsed</span> <span class="r-out co"><span class="r-pr">#></span> <0 rows> (or 0-length row.names)</span> -<span class="r-in"><span class="fu">add_journal</span><span class="op">(</span>status <span class="op">=</span> <span class="st">"Nothing to be done..."</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">add_journal</span><span class="op">(</span>status <span class="op">=</span> <span class="st">"Nothing to be done..."</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Trying to add status information to an empty journal.</span> <span class="r-out co"><span class="r-pr">#></span> [1] task status start end elapsed</span> <span class="r-out co"><span class="r-pr">#></span> <0 rows> (or 0-length row.names)</span> -<span class="r-in"><span class="op">{</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span></span> -<span class="r-in"> task <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sprintf.html" class="external-link">sprintf</a></span><span class="op">(</span></span> -<span class="r-in"> <span class="st">"maintain gaspar with floodam.data (%s)"</span>,</span> -<span class="r-in"> <span class="fu">utils</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/utils/packageDescription.html" class="external-link">packageVersion</a></span><span class="op">(</span><span class="st">"floodam.data"</span><span class="op">)</span></span> -<span class="r-in"> <span class="op">)</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">.1</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, task <span class="op">=</span> <span class="st">"download_gaspar"</span>, degree <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, task <span class="op">=</span> <span class="st">"adapt_gaspar"</span>, degree <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">.1</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, task <span class="op">=</span> <span class="st">"alert_gaspar"</span>, degree <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span>, id <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">.1</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span>, task <span class="op">=</span> <span class="st">"alert_gaspar"</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span><span class="op">)</span></span> -<span class="r-in"><span class="va">journal</span></span> -<span class="r-in"><span class="op">}</span></span> +<span class="r-in"><span><span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span></span></span> +<span class="r-in"><span> task <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sprintf.html" class="external-link">sprintf</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> <span class="st">"maintain gaspar with floodam.data (%s)"</span>,</span></span> +<span class="r-in"><span> <span class="fu">utils</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/utils/packageDescription.html" class="external-link">packageVersion</a></span><span class="op">(</span><span class="st">"floodam.data"</span><span class="op">)</span></span></span> +<span class="r-in"><span> <span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">.1</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, task <span class="op">=</span> <span class="st">"download_gaspar"</span>, degree <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, task <span class="op">=</span> <span class="st">"adapt_gaspar"</span>, degree <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">.1</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, task <span class="op">=</span> <span class="st">"alert_gaspar"</span>, degree <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span>, id <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">.1</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span>, task <span class="op">=</span> <span class="st">"alert_gaspar"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">add_journal</span><span class="op">(</span><span class="va">journal</span>, status <span class="op">=</span> <span class="st">"Done"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">journal</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [1] maintain gaspar with floodam.data (0.9.35.0)...</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:11.830803: [1] maintain gaspar with floodam.data (0.9.36.0)...</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [2] download_gaspar...</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:11.937106: [2] download_gaspar...</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [3] adapt_gaspar...</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:11.940669: [3] adapt_gaspar...</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [4] alert_gaspar...</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:12.044554: [4] alert_gaspar...</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [2] download_gaspar... Done [00:00:00:00.11]</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:11.937106: [2] download_gaspar... Done [00:00:00:00.11]</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [4] alert_gaspar... Done [00:00:00:00.11]</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:12.044554: [4] alert_gaspar... Done [00:00:00:00.11]</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [3] adapt_gaspar... Done [00:00:00:00.21]</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:11.940669: [3] adapt_gaspar... Done [00:00:00:00.21]</span> <span class="r-msg co"><span class="r-pr">#></span> </span> -<span class="r-msg co"><span class="r-pr">#></span> 2023-03-27 13:51:15: [1] maintain gaspar with floodam.data (0.9.35.0)... Done [00:00:00:00.32]</span> +<span class="r-msg co"><span class="r-pr">#></span> 2023-05-02 07:58:11.830803: [1] maintain gaspar with floodam.data (0.9.36.0)... Done [00:00:00:00.33]</span> <span class="r-out co"><span class="r-pr">#></span> start end</span> -<span class="r-out co"><span class="r-pr">#></span> 1 2023-03-27 13:51:15 2023-03-27 13:51:16</span> -<span class="r-out co"><span class="r-pr">#></span> 2 2023-03-27 13:51:15 2023-03-27 13:51:15</span> -<span class="r-out co"><span class="r-pr">#></span> 3 2023-03-27 13:51:15 2023-03-27 13:51:16</span> -<span class="r-out co"><span class="r-pr">#></span> 4 2023-03-27 13:51:15 2023-03-27 13:51:16</span> +<span class="r-out co"><span class="r-pr">#></span> 1 2023-05-02 07:58:11 2023-05-02 07:58:12</span> +<span class="r-out co"><span class="r-pr">#></span> 2 2023-05-02 07:58:11 2023-05-02 07:58:12</span> +<span class="r-out co"><span class="r-pr">#></span> 3 2023-05-02 07:58:11 2023-05-02 07:58:12</span> +<span class="r-out co"><span class="r-pr">#></span> 4 2023-05-02 07:58:12 2023-05-02 07:58:12</span> <span class="r-out co"><span class="r-pr">#></span> task status degree elapsed</span> -<span class="r-out co"><span class="r-pr">#></span> 1 maintain gaspar with floodam.data (0.9.35.0) Done 0 00:00:00:00.32</span> +<span class="r-out co"><span class="r-pr">#></span> 1 maintain gaspar with floodam.data (0.9.36.0) Done 0 00:00:00:00.33</span> <span class="r-out co"><span class="r-pr">#></span> 2 download_gaspar Done 1 00:00:00:00.11</span> <span class="r-out co"><span class="r-pr">#></span> 3 adapt_gaspar Done 1 00:00:00:00.21</span> <span class="r-out co"><span class="r-pr">#></span> 4 alert_gaspar Done 1 00:00:00:00.11</span> @@ -218,7 +230,7 @@ formatted by <code>floodam.date:::format_journal</code>.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/add_journal_old.html b/docs/reference/add_journal_old.html index 9fc2c25b93e1e2b9b43136d9f63cf7db3de39eb1..0c5fa805e4f74d069241fd9435bff27f237df4bc 100644 --- a/docs/reference/add_journal_old.html +++ b/docs/reference/add_journal_old.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,23 +89,32 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">add_journal_old</span><span class="op">(</span><span class="va">...</span>, journal <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/character.html" class="external-link">character</a></span><span class="op">(</span><span class="op">)</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span>, first <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">add_journal_old</span><span class="op">(</span><span class="va">...</span>, journal <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/character.html" class="external-link">character</a></span><span class="op">(</span><span class="op">)</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span>, first <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>...</dt> <dd><p>zero or more objects which can be coerced to character.</p></dd> + + <dt>journal</dt> <dd><p>character vector, journal</p></dd> + + <dt>verbose</dt> <dd><p>logical, should x generates a diagnostic message</p></dd> + + <dt>first</dt> <dd><p>logical, should ... be considered as a first message or a second one preceeded by tabulation</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>updated journal</p> + + +<p>updated journal</p> </div> <div id="author"> <h2>Author</h2> @@ -115,10 +123,10 @@ <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">journal</span> <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">add_journal_old</span><span class="op">(</span><span class="st">"Operation started."</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">add_journal_old</span><span class="op">(</span><span class="st">"No problem occurred."</span>, journal <span class="op">=</span> <span class="va">journal</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">journal</span> <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">add_journal_old</span><span class="op">(</span><span class="st">"Operation started."</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">add_journal_old</span><span class="op">(</span><span class="st">"No problem occurred."</span>, journal <span class="op">=</span> <span class="va">journal</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "\tOperation started." "\tNo problem occurred."</span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">add_journal_old</span><span class="op">(</span><span class="st">"No problem occurred."</span>, journal <span class="op">=</span> <span class="va">journal</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">add_journal_old</span><span class="op">(</span><span class="st">"No problem occurred."</span>, journal <span class="op">=</span> <span class="va">journal</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> <span class="r-msg co"><span class="r-pr">#></span> ... No problem occurred.</span> <span class="r-out co"><span class="r-pr">#></span> [1] "\tOperation started." "\tNo problem occurred."</span> </code></pre></div> @@ -135,7 +143,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/add_log_info.html b/docs/reference/add_log_info.html index e4fcefbe8a1260986a71130249b640e7f1017168..278d19fe02dee0d02ae020132a5f18ce5a344cc5 100644 --- a/docs/reference/add_log_info.html +++ b/docs/reference/add_log_info.html @@ -19,7 +19,7 @@ on the parameter verbose."><meta property="og:image" content="/logo.png"><!-- ma </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ on the parameter verbose."><meta property="og:image" content="/logo.png"><!-- ma <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,37 +93,54 @@ on the parameter verbose.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">add_log_info</span><span class="op">(</span><span class="va">x</span>, <span class="va">fun</span>, <span class="va">info</span>, <span class="va">journal</span>, <span class="va">verbose</span>, <span class="va">verification</span>, level <span class="op">=</span> <span class="fl">1</span>, <span class="va">...</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">add_log_info</span><span class="op">(</span><span class="va">x</span>, <span class="va">fun</span>, <span class="va">info</span>, <span class="va">journal</span>, <span class="va">verbose</span>, <span class="va">verification</span>, level <span class="op">=</span> <span class="fl">1</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>data to be adapted.</p></dd> + + <dt>fun</dt> <dd><p>function, the analysis that may performed on x.</p></dd> + + <dt>info</dt> <dd><p>list, gives the name of the step both in 'short' and 'long' terms.</p></dd> + + <dt>journal</dt> <dd><p>either FALSE, if not must be a character of length one, and will be interpreted at the log file where to save any log information. Its format should be in '<em>.log' in order to create also a '</em>-log.csv' log file that will store information on time and any given verification in csv format.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the some messages be sent in real time.</p></dd> + + <dt>verification</dt> <dd><p>expression, a simple treatment that will be added to *log.csv, may be missing.</p></dd> + + <dt>level</dt> <dd><p>integer, the number of tabulation that will be added to the message.</p></dd> + + <dt>...</dt> <dd><p>anything that may be needed by fun.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>x transformed by fun</p> + + +<p>x transformed by fun</p> </div> <div id="author"> <h2>Author</h2> @@ -143,7 +159,7 @@ message.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/add_transparency.html b/docs/reference/add_transparency.html index 0e6791edb5de6b7537c1dd67fada4bdbd8cb6491..6dce03d460cd3effa6d7b2d30aaa9f2251e859db 100644 --- a/docs/reference/add_transparency.html +++ b/docs/reference/add_transparency.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,21 +89,28 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">add_transparency</span><span class="op">(</span><span class="va">x</span>, alpha <span class="op">=</span> <span class="fl">0</span>, maxColorValue <span class="op">=</span> <span class="fl">255</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">add_transparency</span><span class="op">(</span><span class="va">x</span>, alpha <span class="op">=</span> <span class="fl">0</span>, maxColorValue <span class="op">=</span> <span class="fl">255</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>vector of original color.</p></dd> + + <dt>alpha</dt> <dd><p>numeric between O and 1, desired transparency.</p></dd> + + <dt>maxColorValue</dt> <dd><p>integer, same as in rgb.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>vector of colors with alpha.</p> + + +<p>vector of colors with alpha.</p> </div> <div id="details"> <h2>Details</h2> @@ -118,14 +124,14 @@ a vector of the maximum length will be generated without any warning.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="fu">add_transparency</span><span class="op">(</span><span class="st">"black"</span>, <span class="fl">.5</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">add_transparency</span><span class="op">(</span><span class="st">"black"</span>, <span class="fl">.5</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "#00000080"</span> -<span class="r-in"><span class="fu">add_transparency</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="st">"black"</span><span class="op">)</span>, <span class="fl">.5</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">add_transparency</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="st">"black"</span><span class="op">)</span>, <span class="fl">.5</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "#FF000080" "#00000080"</span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># No warnings when length differs</span></span> -<span class="r-in"><span class="fu">add_transparency</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"#000000FF"</span>, <span class="st">"black"</span>, <span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">.5</span>, <span class="fl">1</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># No warnings when length differs</span></span></span> +<span class="r-in"><span><span class="fu">add_transparency</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"#000000FF"</span>, <span class="st">"black"</span>, <span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">.5</span>, <span class="fl">1</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "#00000000" "#00000080" "#FF0000FF" "#0000FF00"</span> </code></pre></div> </div> @@ -141,7 +147,7 @@ a vector of the maximum length will be generated without any warning.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/alert_gaspar.html b/docs/reference/alert_gaspar.html index ab24d6b6f6262806a2cb58c67eef43d4eef34660..9c7c5d126c2b041c30d0d560c6a24702dd634968 100644 --- a/docs/reference/alert_gaspar.html +++ b/docs/reference/alert_gaspar.html @@ -25,7 +25,7 @@ Exposition of observations (belonging or not to eaip) is added. </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -39,41 +39,40 @@ Exposition of observations (belonging or not to eaip) is added. <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -103,27 +102,40 @@ Exposition of observations (belonging or not to eaip) is added. </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">alert_gaspar</span><span class="op">(</span><span class="va">origin</span>, <span class="va">current</span>, <span class="va">past</span>, <span class="va">scope</span>, alert <span class="op">=</span> <span class="cn">TRUE</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">alert_gaspar</span><span class="op">(</span><span class="va">origin</span>, <span class="va">current</span>, <span class="va">past</span>, <span class="va">scope</span>, alert <span class="op">=</span> <span class="cn">TRUE</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>current</dt> <dd><p>character, date of the current data;</p></dd> + + <dt>past</dt> <dd><p>character, date of the past data.</p></dd> + + <dt>scope</dt> <dd><p>list, named list of scope (vector of commune).</p></dd> + + <dt>alert</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -132,13 +144,13 @@ Exposition of observations (belonging or not to eaip) is added. <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"data-local/georisques/gaspar"</span></span> -<span class="r-in"><span class="fu"><a href="download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="va">catnat</span> <span class="op">=</span> <span class="fu"><a href="adapt_gaspar.html">adapt_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span>, scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"so_ii"</span> <span class="op">=</span> <span class="fu">so.ii</span><span class="fu">::</span><span class="va"><a href="https://rdrr.io/pkg/so.ii/man/so_ii_scope.html" class="external-link">so_ii_scope</a></span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">alert_gaspar</span><span class="op">(</span><span class="va">origin</span>, scope <span class="op">=</span> <span class="st">"so_ii"</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"data-local/georisques/gaspar"</span></span></span> +<span class="r-in"><span><span class="fu"><a href="download_gaspar.html">download_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">catnat</span> <span class="op">=</span> <span class="fu"><a href="adapt_gaspar.html">adapt_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span>, scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"so_ii"</span> <span class="op">=</span> <span class="fu">so.ii</span><span class="fu">::</span><span class="va">so_ii_scope</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">alert_gaspar</span><span class="op">(</span><span class="va">origin</span>, scope <span class="op">=</span> <span class="st">"so_ii"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -153,7 +165,7 @@ Exposition of observations (belonging or not to eaip) is added. </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/alert_mattermost.html b/docs/reference/alert_mattermost.html index 705d4150826505ddce0a54c29c5385c26d5308df..8277b94687fcfcdab9089f237322ebaa35d306c7 100644 --- a/docs/reference/alert_mattermost.html +++ b/docs/reference/alert_mattermost.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,37 +89,48 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">alert_mattermost</span><span class="op">(</span> - <span class="va">msg</span>, - server <span class="op">=</span> <span class="st">"https://mattermost.g-eau.fr"</span>, - hook <span class="op">=</span> <span class="st">"t431oh78k3fcmjtoukr1myy16o"</span>, - user <span class="op">=</span> <span class="st">"floodam.data"</span>, - alert <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">alert_mattermost</span><span class="op">(</span></span> +<span> <span class="va">msg</span>,</span> +<span> server <span class="op">=</span> <span class="st">"https://mattermost.g-eau.fr"</span>,</span> +<span> hook <span class="op">=</span> <span class="st">"t431oh78k3fcmjtoukr1myy16o"</span>,</span> +<span> user <span class="op">=</span> <span class="st">"floodam.data"</span>,</span> +<span> alert <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>msg</dt> <dd><p>character, the message to be sent.</p></dd> + + <dt>server</dt> <dd><p>character, the address of the mattermost server</p></dd> + + <dt>hook</dt> <dd><p>character, the hook to send message</p></dd> + + <dt>user</dt> <dd><p>character, the username to be used</p></dd> + + <dt>alert</dt> <dd><p>logical, should the message be sent</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="fu">alert_mattermost</span><span class="op">(</span><span class="st">"Sorry for disturbance, this is a test."</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">alert_mattermost</span><span class="op">(</span><span class="st">"Sorry for disturbance, this is a test."</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -135,7 +145,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/analyse_archive.html b/docs/reference/analyse_archive.html index 701d7d7bd0b096a19d81d8178dc88d97ce7a0d9c..437c1e43b6f2f14371b77518195746f6f8f7778c 100644 --- a/docs/reference/analyse_archive.html +++ b/docs/reference/analyse_archive.html @@ -32,7 +32,7 @@ case, the projection is not given."><meta property="og:image" content="/logo.png </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -46,41 +46,40 @@ case, the projection is not given."><meta property="og:image" content="/logo.png <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -120,20 +119,25 @@ case, the projection is not given.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">analyse_archive</span><span class="op">(</span><span class="va">x</span>, origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ign"</span>, <span class="st">"floodam.data"</span><span class="op">)</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">analyse_archive</span><span class="op">(</span><span class="va">x</span>, origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ign"</span>, <span class="st">"floodam.data"</span><span class="op">)</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character vector</p></dd> + + <dt>origin</dt> <dd><p>character, to choose the format. Only "ign" is available at the moment.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>either a vector or a matrix depending on the length of x.</p> + + +<p>either a vector or a matrix depending on the length of x.</p> </div> <div id="author"> <h2>Author</h2> @@ -142,17 +146,17 @@ moment.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">ign</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15.7z"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15.7z.001"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_BAD_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_BAD_FRA_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__BAD_LAMB93_FRA_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15_toto"</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">analyse_archive</span><span class="op">(</span><span class="va">ign</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">ign</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15.7z"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15.7z.001"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_BAD_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_BAD_FRA_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__BAD_LAMB93_FRA_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15_toto"</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">analyse_archive</span><span class="op">(</span><span class="va">ign</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: BAD is not an official IGN scope.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: BAD is not an official IGN projection.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: BAD is not an official IGN type.</span> @@ -212,7 +216,7 @@ moment.</p></dd> <span class="r-out co"><span class="r-pr">#></span> ADMIN-EXPRESS-COG_3-1__BAD_LAMB93_FRA_2022-04-15 "ADMIN-EXPRESS-COG_3-1__BAD_LAMB93_FRA_2022-04-15" </span> <span class="r-out co"><span class="r-pr">#></span> ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA "ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA" </span> <span class="r-out co"><span class="r-pr">#></span> ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15_toto "ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15_toto"</span> -<span class="r-in"><span class="fu">analyse_archive</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="va">ign</span>, <span class="fl">2</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">analyse_archive</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="va">ign</span>, <span class="fl">2</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: BAD is not an official IGN scope.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: BAD is not an official IGN projection.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: BAD is not an official IGN type.</span> @@ -325,17 +329,17 @@ moment.</p></dd> <span class="r-out co"><span class="r-pr">#></span> ADMIN-EXPRESS-COG_3-1__BAD_LAMB93_FRA_2022-04-15 "ADMIN-EXPRESS-COG_3-1__BAD_LAMB93_FRA_2022-04-15" </span> <span class="r-out co"><span class="r-pr">#></span> ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA "ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA" </span> <span class="r-out co"><span class="r-pr">#></span> ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15_toto "ADMIN-EXPRESS-COG_3-1__SHP_LAMB93_FRA_2022-04-15_toto"</span> -<span class="r-in"></span> -<span class="r-in"><span class="va">floodam</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span> -<span class="r-in"> <span class="st">"admin-express_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"admin-express_2022-04-15.rds"</span>,</span> -<span class="r-in"> <span class="st">"admin-express_commune_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"admin-express_D034_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"admin-express_commune_D034_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"admin-express_D034_commune_2022-04-15"</span>,</span> -<span class="r-in"> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15.7z"</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">analyse_archive</span><span class="op">(</span><span class="va">floodam</span>, <span class="st">"floodam.data"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="va">floodam</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> <span class="st">"admin-express_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"admin-express_2022-04-15.rds"</span>,</span></span> +<span class="r-in"><span> <span class="st">"admin-express_commune_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"admin-express_D034_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"admin-express_commune_D034_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"admin-express_D034_commune_2022-04-15"</span>,</span></span> +<span class="r-in"><span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15.7z"</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">analyse_archive</span><span class="op">(</span><span class="va">floodam</span>, <span class="st">"floodam.data"</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: admin-express_D034_commune_2022-04-15 cannot be analysed. Should be data_precision_scope_vintage, with possible missings but not reordering. NAs returned.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>analyse_archive WARNING: 7 slot(s) found in ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15. This is not compatible with floodam.data's scheme. NAs returned.</span> <span class="r-out co"><span class="r-pr">#></span> data </span> @@ -384,7 +388,7 @@ moment.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/analyse_catnat.html b/docs/reference/analyse_catnat.html index c5f8b45c88ba098346d9f4debb0497755b70a574..45862c0412cc18e09f80b08a6b9eabcf156c661f 100644 --- a/docs/reference/analyse_catnat.html +++ b/docs/reference/analyse_catnat.html @@ -24,7 +24,7 @@ computed. </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -38,41 +38,40 @@ computed. <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -101,17 +100,20 @@ computed.</p></li> </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">analyse_catnat</span><span class="op">(</span><span class="va">catnat</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">analyse_catnat</span><span class="op">(</span><span class="va">catnat</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>catnat</dt> <dd><p>data.frame, data to be analysed</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list of analysis (catnat, event, year, month, and type)</p> + + +<p>A list of analysis (catnat, event, year, month, and type)</p> </div> <div id="author"> <h2>Author</h2> @@ -130,7 +132,7 @@ computed.</p></li> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/analyse_dwelling.html b/docs/reference/analyse_dwelling.html index 10358a9583e690105f65f2dc42a6d407e01cdde1..775a1e6a26ff64d2a07b0a2e96993c7cdaae1faf 100644 --- a/docs/reference/analyse_dwelling.html +++ b/docs/reference/analyse_dwelling.html @@ -21,7 +21,7 @@ function creates tables in csv format and png image files in path."><meta proper </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -35,41 +35,40 @@ function creates tables in csv format and png image files in path."><meta proper <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -98,48 +97,65 @@ function creates tables in csv format and png image files in path.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">analyse_dwelling</span><span class="op">(</span> - <span class="va">origin</span>, - destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/grep.html" class="external-link">gsub</a></span><span class="op">(</span><span class="st">"building"</span>, <span class="st">"dwelling"</span>, <span class="va">origin</span><span class="op">)</span>, - <span class="va">archive</span>, - category <span class="op">=</span> <span class="st">"Résidentiel"</span>, - dwelling_mean_surf <span class="op">=</span> <span class="op">(</span><span class="fl">90</span> <span class="op">*</span> <span class="fl">1.2</span><span class="op">)</span>, - report <span class="op">=</span> <span class="cn">TRUE</span>, - retrieve <span class="op">=</span> <span class="cn">TRUE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">analyse_dwelling</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/grep.html" class="external-link">gsub</a></span><span class="op">(</span><span class="st">"building"</span>, <span class="st">"dwelling"</span>, <span class="va">origin</span><span class="op">)</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> category <span class="op">=</span> <span class="st">"Résidentiel"</span>,</span> +<span> dwelling_mean_surf <span class="op">=</span> <span class="op">(</span><span class="fl">90</span> <span class="op">*</span> <span class="fl">1.2</span><span class="op">)</span>,</span> +<span> report <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where output should be saved. The function expects it to be the same provided to function. <code>extract_dwelling</code> if it has been previously invoked in the analysis. Default to same path as origin but substituting automatically keyword 'building' by keyword 'dwelling' when possible</p></dd> + + <dt>archive</dt> <dd><p>character, vector of filenames to be processed. If missing, analyse_dwelling is recursively called on all admissible archives found in origin.</p></dd> + + <dt>category</dt> <dd><p>character, focus of the analysis. Default to "Résidentiel".</p></dd> + + <dt>dwelling_mean_surf</dt> <dd><p>numeric, average surface of a dwelling in France. Default to 90 m^2, which is from adapted to the GT AMC's methodology.</p></dd> + + <dt>report</dt> <dd><p>logical, should the function create a summary report with the outputs. Default to TRUE.</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the output of the function be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list of analysis if 'retrieve = TRUE'.</p> + + +<p>A list of analysis if 'retrieve = TRUE'.</p> </div> <div id="author"> <h2>Author</h2> @@ -148,28 +164,28 @@ outputs. Default to TRUE.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># calling function. Long version</span></span> -<span class="r-in"> <span class="va">tab_building</span> <span class="op">=</span> <span class="fu">analyse_dwelling</span><span class="op">(</span></span> -<span class="r-in"> archive <span class="op">=</span> <span class="st">"bdtopo-building-2022-03-15-D034.rds"</span>,</span> -<span class="r-in"> origin <span class="op">=</span> <span class="va">path_building</span>,</span> -<span class="r-in"> destination <span class="op">=</span> <span class="va">path_dwelling</span>,</span> -<span class="r-in"> category <span class="op">=</span> <span class="st">"Résidentiel"</span>,</span> -<span class="r-in"> vintage <span class="op">=</span> <span class="st">"2022-03-15"</span></span> -<span class="r-in"> <span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># calling function. short version</span></span> -<span class="r-in"> <span class="va">tab_building</span> <span class="op">=</span> <span class="fu">analyse_dwelling</span><span class="op">(</span></span> -<span class="r-in"> archive <span class="op">=</span> <span class="st">"bdtopo-building-2022-03-15-D034.rds"</span>,</span> -<span class="r-in"> origin <span class="op">=</span> <span class="va">path_building</span>,</span> -<span class="r-in"> destination <span class="op">=</span> <span class="va">path_dwelling</span></span> -<span class="r-in"> <span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># calling function. recursive version</span></span> -<span class="r-in"> <span class="fu">analyse_dwelling</span><span class="op">(</span>origin <span class="op">=</span> <span class="va">path_building</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> -<span class="r-in"></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># calling function. Long version</span></span></span> +<span class="r-in"><span> <span class="va">tab_building</span> <span class="op">=</span> <span class="fu">analyse_dwelling</span><span class="op">(</span></span></span> +<span class="r-in"><span> archive <span class="op">=</span> <span class="st">"bdtopo-building-2022-03-15-D034.rds"</span>,</span></span> +<span class="r-in"><span> origin <span class="op">=</span> <span class="va">path_building</span>,</span></span> +<span class="r-in"><span> destination <span class="op">=</span> <span class="va">path_dwelling</span>,</span></span> +<span class="r-in"><span> category <span class="op">=</span> <span class="st">"Résidentiel"</span>,</span></span> +<span class="r-in"><span> vintage <span class="op">=</span> <span class="st">"2022-03-15"</span></span></span> +<span class="r-in"><span> <span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># calling function. short version</span></span></span> +<span class="r-in"><span> <span class="va">tab_building</span> <span class="op">=</span> <span class="fu">analyse_dwelling</span><span class="op">(</span></span></span> +<span class="r-in"><span> archive <span class="op">=</span> <span class="st">"bdtopo-building-2022-03-15-D034.rds"</span>,</span></span> +<span class="r-in"><span> origin <span class="op">=</span> <span class="va">path_building</span>,</span></span> +<span class="r-in"><span> destination <span class="op">=</span> <span class="va">path_dwelling</span></span></span> +<span class="r-in"><span> <span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># calling function. recursive version</span></span></span> +<span class="r-in"><span> <span class="fu">analyse_dwelling</span><span class="op">(</span>origin <span class="op">=</span> <span class="va">path_building</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> +<span class="r-in"><span></span></span> </code></pre></div> </div> </div> @@ -184,7 +200,7 @@ outputs. Default to TRUE.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/analyse_intersection.html b/docs/reference/analyse_intersection.html index bd200daf5cd5fd8cd3afde9c91d7786a289a216f..1f5dbb38fe125b8e5cb9a6590dc1df09964ef4fb 100644 --- a/docs/reference/analyse_intersection.html +++ b/docs/reference/analyse_intersection.html @@ -22,7 +22,7 @@ if scope is given, a subpart of data is also saved </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -36,41 +36,40 @@ if scope is given, a subpart of data is also saved <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -97,36 +96,49 @@ if scope is given, a subpart of data is also saved </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">analyse_intersection</span><span class="op">(</span> - <span class="va">x</span>, - <span class="va">y</span>, - analysis <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"intersect"</span>, <span class="st">"proportion"</span><span class="op">)</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span> - -<span class="fu">analyse_eaip</span><span class="op">(</span><span class="va">x</span>, <span class="va">eaip</span>, analysis <span class="op">=</span> <span class="st">"intersect"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">analyse_intersection</span><span class="op">(</span></span> +<span> <span class="va">x</span>,</span> +<span> <span class="va">y</span>,</span> +<span> analysis <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"intersect"</span>, <span class="st">"proportion"</span><span class="op">)</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span> +<span></span> +<span><span class="fu">analyse_eaip</span><span class="op">(</span><span class="va">x</span>, <span class="va">eaip</span>, analysis <span class="op">=</span> <span class="st">"intersect"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>sf object, spatial DB that is analysed.</p></dd> + + <dt>y</dt> <dd><p>sf object, spatial DB that is used for the analysis.</p></dd> + + <dt>analysis</dt> <dd><p>character, analyses that is performed. Default to <code>c("intersect", "proportion")</code>. See details.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function gives some messages. Default to* TRUE.</p></dd> + + <dt>eaip</dt> <dd><p>sf objectf, eaip DB that is used for the analysis.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>analyse_intersection returns a data.frame, whose columns contain analyses -performed. -analyse_eaip returns a sf object, basically x with added columns for each + + +<p>analyse_intersection returns a data.frame, whose columns contain analyses +performed.</p> + + +<p>analyse_eaip returns a sf object, basically x with added columns for each analysis performed.</p> </div> <div id="functions"> @@ -142,12 +154,12 @@ and eaip DB</p></li> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"data-local/georisques/gaspar"</span></span> -<span class="r-in"><span class="fu"><a href="adapt_gaspar.html">adapt_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="adapt_gaspar.html">adapt_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"2022-02-28"</span><span class="op">)</span>, scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"so_ii"</span> <span class="op">=</span> <span class="fu">so.ii</span><span class="fu">::</span><span class="va"><a href="https://rdrr.io/pkg/so.ii/man/so_ii_scope.html" class="external-link">so_ii_scope</a></span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"data-local/georisques/gaspar"</span></span></span> +<span class="r-in"><span><span class="fu"><a href="adapt_gaspar.html">adapt_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="adapt_gaspar.html">adapt_gaspar</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"2022-02-28"</span><span class="op">)</span>, scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"so_ii"</span> <span class="op">=</span> <span class="fu">so.ii</span><span class="fu">::</span><span class="va">so_ii_scope</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -162,7 +174,7 @@ and eaip DB</p></li> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/analyse_ppr.html b/docs/reference/analyse_ppr.html index b20e6536319d126018c9b4792406a01163cb55b2..1f6cf9627172b8bbb9cabe2ab97a09249ad17372 100644 --- a/docs/reference/analyse_ppr.html +++ b/docs/reference/analyse_ppr.html @@ -29,7 +29,7 @@ otherwise the commune's state is NA. </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -43,41 +43,40 @@ otherwise the commune's state is NA. <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -111,17 +110,20 @@ otherwise the commune's state is NA.</p></li> </ul></div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">analyse_ppr</span><span class="op">(</span><span class="va">ppr</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">analyse_ppr</span><span class="op">(</span><span class="va">ppr</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>ppr</dt> <dd><p>data.frame, data to be analysed</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list of analysis (detail, summary)</p> + + +<p>A list of analysis (detail, summary)</p> </div> <div id="author"> <h2>Author</h2> @@ -140,7 +142,7 @@ otherwise the commune's state is NA.</p></li> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/analyse_ppr_state.html b/docs/reference/analyse_ppr_state.html index 78769a909f39d2e51dbb6376f551ad2b38be08fa..17cc137ff4cc2a1a2920e94fe8d36471fea9c5ec 100644 --- a/docs/reference/analyse_ppr_state.html +++ b/docs/reference/analyse_ppr_state.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,17 +89,20 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">analyse_ppr_state</span><span class="op">(</span><span class="va">ppr</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">analyse_ppr_state</span><span class="op">(</span><span class="va">ppr</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>ppr</dt> <dd><p>data.frame, data to be analysed</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A factor of state.</p> + + +<p>A factor of state.</p> </div> <div id="author"> <h2>Author</h2> @@ -119,7 +121,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/apply_scheme.html b/docs/reference/apply_scheme.html index 302ad2f3bd6b3f431cde0ad04d64042ebb79321c..6d18fc82898e401abb07dcbb7affb535aca289d1 100644 --- a/docs/reference/apply_scheme.html +++ b/docs/reference/apply_scheme.html @@ -19,7 +19,7 @@ the type of variable."><meta property="og:image" content="/logo.png"><!-- mathja </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ the type of variable."><meta property="og:image" content="/logo.png"><!-- mathja <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,24 +93,33 @@ the type of variable.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">apply_scheme</span><span class="op">(</span><span class="va">x</span>, <span class="va">scheme</span>, selection <span class="op">=</span> <span class="cn">NULL</span>, name_origin <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">apply_scheme</span><span class="op">(</span><span class="va">x</span>, <span class="va">scheme</span>, selection <span class="op">=</span> <span class="cn">NULL</span>, name_origin <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>data.frame or sf, data to be adapted.</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, scheme to be applied.</p></dd> + + <dt>selection</dt> <dd><p>list, for big scheme a way to select entries. See details</p></dd> + + <dt>name_origin</dt> <dd><p>character, when different 'name_origin' are provided, a way to select the good one.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>data adapted, keeping geometry for 'sf' objects.</p> + + +<p>data adapted, keeping geometry for 'sf' objects.</p> </div> <div id="details"> <h2>Details</h2> @@ -138,7 +146,7 @@ scheme. The simplest, the best.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/basename_extended.html b/docs/reference/basename_extended.html index 18fb9ce7fba56feecc57e82ada64625cae78b98b..a2f35b18c95a09e5830e1799bc3c72b88aacd705 100644 --- a/docs/reference/basename_extended.html +++ b/docs/reference/basename_extended.html @@ -18,7 +18,7 @@ tools::file_ext() and others corresponding functions."><meta property="og:image" </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ tools::file_ext() and others corresponding functions."><meta property="og:image" <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,19 +91,22 @@ tools::file_ext() and others corresponding functions."><meta property="og:image" </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">basename_core</span><span class="op">(</span><span class="va">x</span><span class="op">)</span> - -<span class="fu">basename_ext</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">basename_core</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">basename_ext</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character vector, file paths</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>character vector of processed files.</p> + + +<p>character vector of processed files.</p> </div> <div id="details"> <h2>Details</h2> @@ -120,30 +122,30 @@ tools::file_ext() and others corresponding functions."><meta property="og:image" <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="co"># equivalent to tools::file_path_sans_ext</span></span> -<span class="r-in"><span class="fu">basename_core</span><span class="op">(</span><span class="st">"toto.7z"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># equivalent to tools::file_path_sans_ext</span></span></span> +<span class="r-in"><span><span class="fu">basename_core</span><span class="op">(</span><span class="st">"toto.7z"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "toto"</span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># different from tools::file_path_sans_ext</span></span> -<span class="r-in"><span class="fu">basename_core</span><span class="op">(</span><span class="st">"toto.7z.001"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># different from tools::file_path_sans_ext</span></span></span> +<span class="r-in"><span><span class="fu">basename_core</span><span class="op">(</span><span class="st">"toto.7z.001"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "toto"</span> -<span class="r-in"><span class="fu">basename_core</span><span class="op">(</span><span class="st">"path/toto.csv"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">basename_core</span><span class="op">(</span><span class="st">"path/toto.csv"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "toto"</span> -<span class="r-in"><span class="fu">basename_core</span><span class="op">(</span><span class="st">"path/toto.csv.gz"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">basename_core</span><span class="op">(</span><span class="st">"path/toto.csv.gz"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "toto"</span> -<span class="r-in"></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># equivalent to tools::file__ext</span></span> -<span class="r-in"><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"toto.7z"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># equivalent to tools::file__ext</span></span></span> +<span class="r-in"><span><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"toto.7z"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "7z"</span> -<span class="r-in"><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"path/toto.csv"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"path/toto.csv"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "csv"</span> -<span class="r-in"></span> -<span class="r-in"><span class="co">#'different from tools::file__ext</span></span> -<span class="r-in"><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"toto.7z.001"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co">#'different from tools::file__ext</span></span></span> +<span class="r-in"><span><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"toto.7z.001"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "7z.001"</span> -<span class="r-in"><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"path/toto.csv.gz"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">basename_ext</span><span class="op">(</span><span class="st">"path/toto.csv.gz"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "csv.gz"</span> </code></pre></div> </div> @@ -159,7 +161,7 @@ tools::file_ext() and others corresponding functions."><meta property="og:image" </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/bd_topo_nature_reclass.html b/docs/reference/bd_topo_nature_reclass.html index ed37d6e2efc6552a2642953e89e2e97b61efde84..6757e5a289c3fb6bf4a759548872726887736149 100644 --- a/docs/reference/bd_topo_nature_reclass.html +++ b/docs/reference/bd_topo_nature_reclass.html @@ -18,7 +18,7 @@ renamed."><meta property="og:image" content="/logo.png"><!-- mathjax --><script </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ renamed."><meta property="og:image" content="/logo.png"><!-- mathjax --><script <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ renamed.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">bd_topo_nature_reclass</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">bd_topo_nature_reclass</span></span></code></pre></div> </div> <div id="format"> @@ -123,7 +122,7 @@ transform the categories in variable 'nature'.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/bd_topo_roof.html b/docs/reference/bd_topo_roof.html index 0eb9be681b007f6f7d99a1a361b6e12c96d59e1a..2c2bee5911ca613f233188f698195b513b637f69 100644 --- a/docs/reference/bd_topo_roof.html +++ b/docs/reference/bd_topo_roof.html @@ -18,7 +18,7 @@ to be renamed."><meta property="og:image" content="/logo.png"><!-- mathjax --><s </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ to be renamed."><meta property="og:image" content="/logo.png"><!-- mathjax --><s <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ to be renamed.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">bd_topo_roof</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">bd_topo_roof</span></span></code></pre></div> </div> <div id="format"> @@ -127,7 +126,7 @@ mixed.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/bd_topo_wall.html b/docs/reference/bd_topo_wall.html index 3a44b4d42a899e5b77eb35fad9bf1639e05296bc..6cf9c7c50cc9e80fba1f13b46f1d00061f205993 100644 --- a/docs/reference/bd_topo_wall.html +++ b/docs/reference/bd_topo_wall.html @@ -18,7 +18,7 @@ to be renamed."><meta property="og:image" content="/logo.png"><!-- mathjax --><s </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ to be renamed."><meta property="og:image" content="/logo.png"><!-- mathjax --><s <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ to be renamed.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">bd_topo_wall</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">bd_topo_wall</span></span></code></pre></div> </div> <div id="format"> @@ -127,7 +126,7 @@ mixed.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/category_label.html b/docs/reference/category_label.html index ca2d50d2cb29501b120043ad0dc7244e07a500be..8755477b7a846a0b403aa9660b37c04c5a2a848c 100644 --- a/docs/reference/category_label.html +++ b/docs/reference/category_label.html @@ -18,7 +18,7 @@ the typology of activities used within floodam.building"><meta property="og:imag </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ the typology of activities used within floodam.building"><meta property="og:imag <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ the typology of activities used within floodam.building</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">category_label</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">category_label</span></span></code></pre></div> </div> <div id="format"> @@ -118,7 +117,7 @@ the typology of activities used within floodam.building</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/catnat_classification.html b/docs/reference/catnat_classification.html index 18c3554c73e68e96f464fe8b8377a727f204773c..2a7ad3e155e6fd21d13fc8d922a533858eed012c 100644 --- a/docs/reference/catnat_classification.html +++ b/docs/reference/catnat_classification.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">catnat_classification</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">catnat_classification</span></span></code></pre></div> </div> <div id="format"> @@ -110,7 +109,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/commune_so_ii.html b/docs/reference/commune_so_ii.html index 86158f0ff7c21d00560b0e4bea0d088fb3467247..ab4cf65fe60c6bddec71d3698ca634a240a473d1 100644 --- a/docs/reference/commune_so_ii.html +++ b/docs/reference/commune_so_ii.html @@ -18,7 +18,7 @@ useful information to make subsets"><meta property="og:image" content="/logo.png </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ useful information to make subsets"><meta property="og:image" content="/logo.png <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ useful information to make subsets</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">commune_so_ii</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">commune_so_ii</span></span></code></pre></div> </div> <div id="format"> @@ -131,7 +130,7 @@ rural.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/complete_pattern.html b/docs/reference/complete_pattern.html index 81be6383ce3961f4e7b43b22814fd239aaf9990f..e784c7083616f4a72762c80fa6c25f373426b938 100644 --- a/docs/reference/complete_pattern.html +++ b/docs/reference/complete_pattern.html @@ -18,7 +18,7 @@ find files of given extension within a vector of names."><meta property="og:imag </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ find files of given extension within a vector of names."><meta property="og:imag <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,34 +91,43 @@ find files of given extension within a vector of names.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">x</span>, begin <span class="op">=</span> <span class="cn">FALSE</span>, ending <span class="op">=</span> <span class="cn">FALSE</span>, extension <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">x</span>, begin <span class="op">=</span> <span class="cn">FALSE</span>, ending <span class="op">=</span> <span class="cn">FALSE</span>, extension <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character, vector of patterns to be completed</p></dd> + + <dt>begin</dt> <dd><p>logical, should the pattern be at the beginning of strings</p></dd> + + <dt>ending</dt> <dd><p>logical, should the pattern be at the end of strings</p></dd> + + <dt>extension</dt> <dd><p>logical, should the pattern considered as an extension with a starting dot</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>character of length one. To each element of x, it is firts applied transformation given by + + +<p>character of length one. To each element of x, it is firts applied transformation given by begin, ending and extention. Then, it is collapsed with "|". It can be used in a grep call.</p> </div> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">extension</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"zip"</span>, <span class="st">"7z"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">extension</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">extension</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"zip"</span>, <span class="st">"7z"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">extension</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "zip|7z"</span> -<span class="r-in"><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">extension</span>, extension <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">extension</span>, extension <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "[.]zip|[.]7z"</span> -<span class="r-in"><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">extension</span>, ending <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">complete_pattern</span><span class="op">(</span><span class="va">extension</span>, ending <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "zip$|7z$"</span> </code></pre></div> </div> @@ -135,7 +143,7 @@ begin, ending and extention. Then, it is collapsed with "|". It can be used in a </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/create_date.html b/docs/reference/create_date.html index 2ad04b6806c657e58dda6f02328e9dc17675c52d..a24a85a2ccc2120d108d69ea367d8145fdf4b08a 100644 --- a/docs/reference/create_date.html +++ b/docs/reference/create_date.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">create_date</span><span class="op">(</span><span class="va">...</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">create_date</span><span class="op">(</span><span class="va">...</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> @@ -98,10 +97,15 @@ <dl><dt>...</dt> <dd><p>Anything that will be coerced to a character. See details for format.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A vector of two dates of format "\<!-- %Y-\\%m-\\%d" --></p> + + +<p>A vector of two dates of format "\<!-- %Y-\\%m-\\%d" --></p> + + </div> <div id="details"> <h2>Details</h2> @@ -117,21 +121,21 @@ month).</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="fl">2020</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="fl">2020</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2020-01-01" "2020-12-31"</span> -<span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="fl">1995</span><span class="op">:</span><span class="fl">2000</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="fl">1995</span><span class="op">:</span><span class="fl">2000</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "1995-01-01" "2000-12-31"</span> -<span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="fl">1995</span>, <span class="fl">2000</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="fl">1995</span>, <span class="fl">2000</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "1995-01-01" "2000-12-31"</span> -<span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="st">"1995"</span>, <span class="st">"2000-02"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="st">"1995"</span>, <span class="st">"2000-02"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "1995-01-01" "2000-02-29"</span> -<span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="st">"2000-02"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="st">"2000-02"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2000-02-01" "2000-02-29"</span> -<span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="st">"2000-02"</span>, <span class="st">"2000-02-15"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="st">"2000-02"</span>, <span class="st">"2000-02-15"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2000-02-01" "2000-02-15"</span> -<span class="r-in"><span class="fu">create_date</span><span class="op">(</span><span class="st">"2000-02-15"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_date</span><span class="op">(</span><span class="st">"2000-02-15"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2000-02-15" "2000-02-15"</span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_date</span><span class="op">(</span><span class="st">"toto"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_date</span><span class="op">(</span><span class="st">"toto"</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -146,7 +150,7 @@ month).</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/create_month.html b/docs/reference/create_month.html index 3856c77a8a11476392d2c7c6ce727cdf7871158b..ddd64923a3f970a37ea0efeb3974e17d0cc8c7a6 100644 --- a/docs/reference/create_month.html +++ b/docs/reference/create_month.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,19 +89,27 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">create_month</span><span class="op">(</span><span class="va">begin</span>, <span class="va">ending</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">create_month</span><span class="op">(</span><span class="va">begin</span>, <span class="va">ending</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>begin</dt> <dd><p>character, begining month. See details for format.</p></dd> + + <dt>ending</dt> <dd><p>character, ending month. See details for format.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A character vector with the sequence of month either in format "\<!-- %m" or "\\%Y-\\%m" depending on -->parameters.</p> + + +<p>A character vector with the sequence of month either in format "\<!-- %m" or "\\%Y-\\%m" depending on --></p> + + +<p>parameters.</p> </div> <div id="details"> <h2>Details</h2> @@ -115,17 +122,17 @@ be written as "\<!-- %Y_\\%m", "\\%Y:\\%m", or "\\%Y/\\%m", eventually with miss <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="co">## Only with month (%m)</span></span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="fl">4</span>, <span class="fl">8</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co">## Only with month (%m)</span></span></span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="fl">4</span>, <span class="fl">8</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "04" "05" "06" "07" "08"</span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="st">"04"</span>, <span class="st">"08"</span><span class="op">)</span> </span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="st">"04"</span>, <span class="st">"08"</span><span class="op">)</span> </span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "04" "05" "06" "07" "08"</span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="st">"08"</span>, <span class="st">"04"</span><span class="op">)</span> </span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="st">"08"</span>, <span class="st">"04"</span><span class="op">)</span> </span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "04" "05" "06" "07" "08"</span> -<span class="r-in"></span> -<span class="r-in"><span class="co">## With year and month (%Y-%m)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-03"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co">## With year and month (%Y-%m)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-03"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2010-03" "2010-04" "2010-05" "2010-06" "2010-07" "2010-08" "2010-09"</span> <span class="r-out co"><span class="r-pr">#></span> [8] "2010-10" "2010-11" "2010-12" "2011-01" "2011-02" "2011-03" "2011-04"</span> <span class="r-out co"><span class="r-pr">#></span> [15] "2011-05" "2011-06" "2011-07" "2011-08" "2011-09" "2011-10" "2011-11"</span> @@ -134,7 +141,7 @@ be written as "\<!-- %Y_\\%m", "\\%Y:\\%m", or "\\%Y/\\%m", eventually with miss <span class="r-out co"><span class="r-pr">#></span> [36] "2013-02" "2013-03" "2013-04" "2013-05" "2013-06" "2013-07" "2013-08"</span> <span class="r-out co"><span class="r-pr">#></span> [43] "2013-09" "2013-10" "2013-11" "2013-12" "2014-01" "2014-02" "2014-03"</span> <span class="r-out co"><span class="r-pr">#></span> [50] "2014-04" "2014-05" "2014-06" "2014-07"</span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="st">"2014-07"</span>, <span class="st">"2010-03"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="st">"2014-07"</span>, <span class="st">"2010-03"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2010-03" "2010-04" "2010-05" "2010-06" "2010-07" "2010-08" "2010-09"</span> <span class="r-out co"><span class="r-pr">#></span> [8] "2010-10" "2010-11" "2010-12" "2011-01" "2011-02" "2011-03" "2011-04"</span> <span class="r-out co"><span class="r-pr">#></span> [15] "2011-05" "2011-06" "2011-07" "2011-08" "2011-09" "2011-10" "2011-11"</span> @@ -143,7 +150,7 @@ be written as "\<!-- %Y_\\%m", "\\%Y:\\%m", or "\\%Y/\\%m", eventually with miss <span class="r-out co"><span class="r-pr">#></span> [36] "2013-02" "2013-03" "2013-04" "2013-05" "2013-06" "2013-07" "2013-08"</span> <span class="r-out co"><span class="r-pr">#></span> [43] "2013-09" "2013-10" "2013-11" "2013-12" "2014-01" "2014-02" "2014-03"</span> <span class="r-out co"><span class="r-pr">#></span> [50] "2014-04" "2014-05" "2014-06" "2014-07"</span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-3"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-3"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2010-03" "2010-04" "2010-05" "2010-06" "2010-07" "2010-08" "2010-09"</span> <span class="r-out co"><span class="r-pr">#></span> [8] "2010-10" "2010-11" "2010-12" "2011-01" "2011-02" "2011-03" "2011-04"</span> <span class="r-out co"><span class="r-pr">#></span> [15] "2011-05" "2011-06" "2011-07" "2011-08" "2011-09" "2011-10" "2011-11"</span> @@ -152,7 +159,7 @@ be written as "\<!-- %Y_\\%m", "\\%Y:\\%m", or "\\%Y/\\%m", eventually with miss <span class="r-out co"><span class="r-pr">#></span> [36] "2013-02" "2013-03" "2013-04" "2013-05" "2013-06" "2013-07" "2013-08"</span> <span class="r-out co"><span class="r-pr">#></span> [43] "2013-09" "2013-10" "2013-11" "2013-12" "2014-01" "2014-02" "2014-03"</span> <span class="r-out co"><span class="r-pr">#></span> [50] "2014-04" "2014-05" "2014-06" "2014-07"</span> -<span class="r-in"><span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-3"</span>, <span class="st">"2014-7"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-3"</span>, <span class="st">"2014-7"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "2010-03" "2010-04" "2010-05" "2010-06" "2010-07" "2010-08" "2010-09"</span> <span class="r-out co"><span class="r-pr">#></span> [8] "2010-10" "2010-11" "2010-12" "2011-01" "2011-02" "2011-03" "2011-04"</span> <span class="r-out co"><span class="r-pr">#></span> [15] "2011-05" "2011-06" "2011-07" "2011-08" "2011-09" "2011-10" "2011-11"</span> @@ -161,11 +168,11 @@ be written as "\<!-- %Y_\\%m", "\\%Y:\\%m", or "\\%Y/\\%m", eventually with miss <span class="r-out co"><span class="r-pr">#></span> [36] "2013-02" "2013-03" "2013-04" "2013-05" "2013-06" "2013-07" "2013-08"</span> <span class="r-out co"><span class="r-pr">#></span> [43] "2013-09" "2013-10" "2013-11" "2013-12" "2014-01" "2014-02" "2014-03"</span> <span class="r-out co"><span class="r-pr">#></span> [50] "2014-04" "2014-05" "2014-06" "2014-07"</span> -<span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="fl">4</span>, <span class="fl">13</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="st">"04"</span>, <span class="st">"13"</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-13"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="st">"01"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="fl">4</span>, <span class="fl">13</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="st">"04"</span>, <span class="st">"13"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="st">"2010-13"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">create_month</span><span class="op">(</span><span class="st">"01"</span>, <span class="st">"2014-07"</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -180,7 +187,7 @@ be written as "\<!-- %Y_\\%m", "\\%Y:\\%m", or "\\%Y/\\%m", eventually with miss </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/define_path.html b/docs/reference/define_path.html index 2bcd4701b938f4240062c27c5546bc8d11430feb..7bd2634139bf80587ed6aa6dce5826c42ac9c824 100644 --- a/docs/reference/define_path.html +++ b/docs/reference/define_path.html @@ -18,7 +18,7 @@ is appended through file.path."><meta property="og:image" content="/logo.png"><! </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ is appended through file.path."><meta property="og:image" content="/logo.png"><! <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,19 +91,24 @@ is appended through file.path.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">define_path</span><span class="op">(</span><span class="va">what</span>, who <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/system.html" class="external-link">system</a></span><span class="op">(</span><span class="st">"logname"</span>, intern <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">define_path</span><span class="op">(</span><span class="va">what</span>, who <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/system.html" class="external-link">system</a></span><span class="op">(</span><span class="st">"logname"</span>, intern <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>what</dt> <dd><p>character, some local paths to be specified.</p></dd> + + <dt>who</dt> <dd><p>character, typically result of logname.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>Character, path.</p> + + +<p>Character, path.</p> </div> <div id="author"> <h2>Author</h2> @@ -113,11 +117,11 @@ is appended through file.path.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="fu">define_path</span><span class="op">(</span><span class="st">"toto"</span><span class="op">)</span> </span> -<span class="r-in"><span class="fu">define_path</span><span class="op">(</span><span class="st">"floodam"</span>, <span class="st">"toto"</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="fu">define_path</span><span class="op">(</span><span class="st">"toto"</span><span class="op">)</span> </span></span> +<span class="r-in"><span><span class="fu">define_path</span><span class="op">(</span><span class="st">"floodam"</span>, <span class="st">"toto"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -132,7 +136,7 @@ is appended through file.path.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/department.html b/docs/reference/department.html index d7677c2e45e8bf95f9d96c63a826f1f800b7ff3c..e9ff022fb10be5a97474944a01fd890246773d6d 100644 --- a/docs/reference/department.html +++ b/docs/reference/department.html @@ -18,7 +18,7 @@ in France."><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ in France."><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ in France.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">department</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">department</span></span></code></pre></div> </div> <div id="format"> @@ -122,7 +121,7 @@ located.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download.geo_sirene.html b/docs/reference/download.geo_sirene.html index 819ef1cdb8d560b15143ada1ea4109b285727410..8b4ae9e71b4a3541151742310ee4de341796dc4d 100644 --- a/docs/reference/download.geo_sirene.html +++ b/docs/reference/download.geo_sirene.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,44 +89,63 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download.geo_sirene</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"cquest"</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - extension <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - month <span class="op">=</span> <span class="cn">NULL</span>, - version_insee <span class="op">=</span> <span class="st">"v2019"</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download.geo_sirene</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"cquest"</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> extension <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> month <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version_insee <span class="op">=</span> <span class="st">"v2019"</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked.</p></dd> + + <dt>origin</dt> <dd><p>character, either a keyword or the address from where data are downloaded. Best to keep it at default value. See details.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded.</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded.</p></dd> + + <dt>version</dt> <dd><p>string, version of ADMIN EXPRESS to be downloaded.</p></dd> + + <dt>date</dt> <dd><p>character, date of the archive to be downloaded.</p></dd> + + <dt>month</dt> <dd><p>character, vector of month to be downloaded</p></dd> + + <dt>version_insee</dt> <dd><p>string, INSEE version to be downloaded. Only used with <code>origin = "cquest"</code>.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="details"> <h2>Details</h2> @@ -149,13 +167,13 @@ which should be the most complete version at France level.</p></li> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/geo_sirene"</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">month</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"2018-11"</span>, <span class="st">"2019-05"</span>, <span class="st">"2020-03"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download.geo_sirene</span><span class="op">(</span><span class="va">origin</span>, <span class="va">destination</span>, month <span class="op">=</span> <span class="va">month</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/geo_sirene"</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">month</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"2018-11"</span>, <span class="st">"2019-05"</span>, <span class="st">"2020-03"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download.geo_sirene</span><span class="op">(</span><span class="va">origin</span>, <span class="va">destination</span>, month <span class="op">=</span> <span class="va">month</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -170,7 +188,7 @@ which should be the most complete version at France level.</p></li> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download.insee.html b/docs/reference/download.insee.html index e170f4d914c80f7ee802e805b2ba494945e8dd61..168a1cc9c0da163a7ffe0cc0f2dd79ac48a2d7c1 100644 --- a/docs/reference/download.insee.html +++ b/docs/reference/download.insee.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,47 +89,64 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download.insee</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"insee"</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - extension <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - year <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download.insee</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"insee"</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> extension <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> year <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked</p></dd> + + <dt>origin</dt> <dd><p>character, either a keyword or the address from where data are downloaded. Best to keep it at default value. See details.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded</p></dd> + + <dt>version</dt> <dd><p>character, version of archive to be downloaded</p></dd> + + <dt>date</dt> <dd><p>string, version of archive to be downloaded</p></dd> + + <dt>year</dt> <dd><p>integer or character, vector of year to be downloaded.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send somme messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download.insee</span><span class="op">(</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download.insee</span><span class="op">(</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -145,7 +161,7 @@ at default value. See details.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download.ppr.html b/docs/reference/download.ppr.html index c43f8d5ac94fd00edfaaec4ba5770017de03b12a..aefe54ed856d6e28867d48fc8150366097bcfa8b 100644 --- a/docs/reference/download.ppr.html +++ b/docs/reference/download.ppr.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,47 +89,62 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download.ppr</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"cquest"</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - extension <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download.ppr</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"cquest"</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> extension <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked</p></dd> + + <dt>origin</dt> <dd><p>character, keyword or the address from where data are downloaded</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded</p></dd> + + <dt>version</dt> <dd><p>character, version of archive to be downloaded</p></dd> + + <dt>date</dt> <dd><p>string, version of archive to be downloaded</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send somme messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"> <span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"> <span class="fu">download.ppr</span><span class="op">(</span><span class="va">destination</span>, version <span class="op">=</span> <span class="st">"34"</span><span class="op">)</span></span> -<span class="r-in"> <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span> <span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span> <span class="fu">download.ppr</span><span class="op">(</span><span class="va">destination</span>, version <span class="op">=</span> <span class="st">"34"</span><span class="op">)</span></span></span> +<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -145,7 +159,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download.rpg.html b/docs/reference/download.rpg.html index d845a42f014d8732e4513568455866bc10826fd5..97f52d4aa5b8b95165646a93318c53f7427cbd8f 100644 --- a/docs/reference/download.rpg.html +++ b/docs/reference/download.rpg.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,40 +89,57 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download.rpg</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"cquest"</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - extension <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - year <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download.rpg</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"cquest"</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> extension <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> year <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked.</p></dd> + + <dt>origin</dt> <dd><p>character, either a keyword or the address from where data are downloaded. See details.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded.</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded.</p></dd> + + <dt>version</dt> <dd><p>string, version of archive to be downloaded.</p></dd> + + <dt>date</dt> <dd><p>character, date of the archive to be downloaded.</p></dd> + + <dt>year</dt> <dd><p>integer or character, vector of year to be downloaded.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="details"> <h2>Details</h2> @@ -147,8 +163,8 @@ This should be only used for year 2010 and 2011. It is not used if year is somet <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download.rpg</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span><span class="op">)</span>, year <span class="op">=</span> <span class="st">"2010"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download.rpg</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span><span class="op">)</span>, year <span class="op">=</span> <span class="st">"2010"</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -163,7 +179,7 @@ This should be only used for year 2010 and 2011. It is not used if year is somet </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download_admin_express.html b/docs/reference/download_admin_express.html index 6667264bf638bf9889c6956bf29772664d0f78dc..b674f09b781c1061a635a34ea43985d65b9f5099 100644 --- a/docs/reference/download_admin_express.html +++ b/docs/reference/download_admin_express.html @@ -18,7 +18,7 @@ options for its use with IGN website and data.cquest.org."><meta property="og:im </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ options for its use with IGN website and data.cquest.org."><meta property="og:im <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,40 +91,55 @@ options for its use with IGN website and data.cquest.org.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download_admin_express</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ign"</span>, <span class="st">"cquest"</span><span class="op">)</span>, - name <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ADMIN-EXPRESS-COG"</span>, <span class="st">"ADMIN-EXPRESS"</span>, <span class="st">"ADMIN-EXPRESS-COG-CARTO"</span><span class="op">)</span>, - extension <span class="op">=</span> <span class="st">"7z"</span>, - date <span class="op">=</span> <span class="st">"last"</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download_admin_express</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ign"</span>, <span class="st">"cquest"</span><span class="op">)</span>,</span> +<span> name <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ADMIN-EXPRESS-COG"</span>, <span class="st">"ADMIN-EXPRESS"</span>, <span class="st">"ADMIN-EXPRESS-COG-CARTO"</span><span class="op">)</span>,</span> +<span> extension <span class="op">=</span> <span class="st">"7z"</span>,</span> +<span> date <span class="op">=</span> <span class="st">"last"</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked.</p></dd> + + <dt>origin</dt> <dd><p>character, a keyword or the address from where data are downloaded.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded.</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded.</p></dd> + + <dt>date</dt> <dd><p>character, date of the archive to be downloaded.</p></dd> + + <dt>version</dt> <dd><p>string, version of Admin Express to be downloaded.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="details"> <h2>Details</h2> @@ -137,11 +151,11 @@ downloaded.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_admin_express</span><span class="op">(</span><span class="va">destination</span>, version <span class="op">=</span> <span class="st">"MYT"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_admin_express</span><span class="op">(</span><span class="va">destination</span>, version <span class="op">=</span> <span class="st">"MYT"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -156,7 +170,7 @@ downloaded.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download_archive.html b/docs/reference/download_archive.html index 5b26099cbe43edfea5cd58b150a1234e03ee349f..ed5cdb340257e1d38ea63209b1fde442fde34b2a 100644 --- a/docs/reference/download_archive.html +++ b/docs/reference/download_archive.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,39 +89,52 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download_archive</span><span class="op">(</span> - <span class="va">to_do</span>, - extension <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"gz"</span>, <span class="st">"zip"</span>, <span class="st">"7z"</span><span class="op">)</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">FALSE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download_archive</span><span class="op">(</span></span> +<span> <span class="va">to_do</span>,</span> +<span> extension <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"gz"</span>, <span class="st">"zip"</span>, <span class="st">"7z"</span><span class="op">)</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">FALSE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>to_do</dt> <dd><p>data.frame. Two columns of character are expected.</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded</p></dd> + + <dt>date</dt> <dd><p>character, something like a date that should be used as a filter.</p></dd> + + <dt>version</dt> <dd><p>character, something like a version that should be used as a filter.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send somme messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="details"> <h2>Details</h2> @@ -135,28 +147,28 @@ downloads!</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">to_do_cquest</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span> -<span class="r-in"> origin <span class="op">=</span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique/2018"</span>,</span> -<span class="r-in"> destination <span class="op">=</span> <span class="va">destination</span>,</span> -<span class="r-in"> short <span class="op">=</span> <span class="st">"rpg_cquest"</span>,</span> -<span class="r-in"> stringsAsFactors <span class="op">=</span> <span class="cn">FALSE</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do_cquest</span>, version <span class="op">=</span> <span class="st">"D976"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="va">to_do_ign</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span> -<span class="r-in"> origin <span class="op">=</span> <span class="st">"https://geoservices.ign.fr/rpg"</span>,</span> -<span class="r-in"> destination <span class="op">=</span> <span class="va">destination</span>,</span> -<span class="r-in"> short <span class="op">=</span> <span class="st">"rpg_ign"</span>,</span> -<span class="r-in"> stringsAsFactors <span class="op">=</span> <span class="cn">FALSE</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do_ign</span>, version <span class="op">=</span> <span class="st">"D976"</span>, date <span class="op">=</span> <span class="st">"2020"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do_ign</span>, version <span class="op">=</span> <span class="st">"D976"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="va">to_do</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">rbind</a></span><span class="op">(</span><span class="va">to_do_cquest</span>, <span class="va">to_do_ign</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do</span>, version <span class="op">=</span> <span class="st">"D976"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">to_do_cquest</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> origin <span class="op">=</span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique/2018"</span>,</span></span> +<span class="r-in"><span> destination <span class="op">=</span> <span class="va">destination</span>,</span></span> +<span class="r-in"><span> short <span class="op">=</span> <span class="st">"rpg_cquest"</span>,</span></span> +<span class="r-in"><span> stringsAsFactors <span class="op">=</span> <span class="cn">FALSE</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do_cquest</span>, version <span class="op">=</span> <span class="st">"D976"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="va">to_do_ign</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> origin <span class="op">=</span> <span class="st">"https://geoservices.ign.fr/rpg"</span>,</span></span> +<span class="r-in"><span> destination <span class="op">=</span> <span class="va">destination</span>,</span></span> +<span class="r-in"><span> short <span class="op">=</span> <span class="st">"rpg_ign"</span>,</span></span> +<span class="r-in"><span> stringsAsFactors <span class="op">=</span> <span class="cn">FALSE</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do_ign</span>, version <span class="op">=</span> <span class="st">"D976"</span>, date <span class="op">=</span> <span class="st">"2020"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do_ign</span>, version <span class="op">=</span> <span class="st">"D976"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="va">to_do</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">rbind</a></span><span class="op">(</span><span class="va">to_do_cquest</span>, <span class="va">to_do_ign</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_archive</span><span class="op">(</span><span class="va">to_do</span>, version <span class="op">=</span> <span class="st">"D976"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -171,7 +183,7 @@ downloads!</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download_ban.html b/docs/reference/download_ban.html index 12d2c9a94ee173cd6890dcd6edd1db379cc7f116..3e8d43fbc792a5a10dddccb6f53e247257a3dc14 100644 --- a/docs/reference/download_ban.html +++ b/docs/reference/download_ban.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,43 +89,62 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download_ban</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"data.gouv"</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - extension <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - department <span class="op">=</span> <span class="cn">NULL</span>, - region <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download_ban</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"data.gouv"</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> extension <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> department <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> region <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked.</p></dd> + + <dt>origin</dt> <dd><p>character, either a keyword or the address from where data are downloaded. See details.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded.</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded.</p></dd> + + <dt>date</dt> <dd><p>character, date of the archive to be downloaded.</p></dd> + + <dt>version</dt> <dd><p>string, version of BAN to be downloaded. See details.</p></dd> + + <dt>department</dt> <dd><p>integer, or converted to integer. Departments that should be considered. See details.</p></dd> + + <dt>region</dt> <dd><p>integer, or converted to integer. Regions that should be considered. See details.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="details"> <h2>Details</h2> @@ -158,16 +176,16 @@ a successful download.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2022-01-01"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, region <span class="op">=</span> <span class="fl">11</span>, date <span class="op">=</span> <span class="st">"2022-01-01"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2022-09-20"</span>, version <span class="op">=</span> <span class="st">"bal"</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2022-01-01"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, region <span class="op">=</span> <span class="fl">11</span>, date <span class="op">=</span> <span class="st">"2022-01-01"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_ban</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2022-09-20"</span>, version <span class="op">=</span> <span class="st">"bal"</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -182,7 +200,7 @@ a successful download.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download_bd_topo.html b/docs/reference/download_bd_topo.html index fc52dfafa0bf4eaa62ff49f2703f538524664aa2..3b0704a4294990620c3b06fe5d6468d4b652d9dd 100644 --- a/docs/reference/download_bd_topo.html +++ b/docs/reference/download_bd_topo.html @@ -19,7 +19,7 @@ aimed archive of BD TOPO from IGN websites."><meta property="og:image" content=" </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ aimed archive of BD TOPO from IGN websites."><meta property="og:image" content=" <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,55 +93,76 @@ aimed archive of BD TOPO from IGN websites.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download_bd_topo</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"ign"</span>, - name <span class="op">=</span> <span class="st">"BDTOPO"</span>, - extension <span class="op">=</span> <span class="st">"7z"</span>, - date <span class="op">=</span> <span class="st">"last"</span>, - type <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"SHP"</span>, <span class="st">"GPKG"</span>, <span class="st">"SQL"</span><span class="op">)</span>, - theme <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"TOUSTHEMES"</span>, <span class="st">"ADMINISTRATIF"</span>, <span class="st">"ADRESSES"</span>, <span class="st">"BDADRESSE"</span>, <span class="st">"ERP"</span>, - <span class="st">"HYDROGRAPHIE"</span>, <span class="st">"TRANSPORT"</span><span class="op">)</span>, - department <span class="op">=</span> <span class="cn">NULL</span>, - region <span class="op">=</span> <span class="cn">NULL</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download_bd_topo</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"ign"</span>,</span> +<span> name <span class="op">=</span> <span class="st">"BDTOPO"</span>,</span> +<span> extension <span class="op">=</span> <span class="st">"7z"</span>,</span> +<span> date <span class="op">=</span> <span class="st">"last"</span>,</span> +<span> type <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"SHP"</span>, <span class="st">"GPKG"</span>, <span class="st">"SQL"</span><span class="op">)</span>,</span> +<span> theme <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"TOUSTHEMES"</span>, <span class="st">"ADMINISTRATIF"</span>, <span class="st">"ADRESSES"</span>, <span class="st">"BDADRESSE"</span>, <span class="st">"ERP"</span>,</span> +<span> <span class="st">"HYDROGRAPHIE"</span>, <span class="st">"TRANSPORT"</span><span class="op">)</span>,</span> +<span> department <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> region <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked.</p></dd> + + <dt>origin</dt> <dd><p>character, either a keyword or the address from where data are downloaded. See details.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded. Default to "BDTOPO".</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded. Default to "7z".</p></dd> + + <dt>date</dt> <dd><p>character, date of the archive to be downloaded. Default to "last".</p></dd> + + <dt>type</dt> <dd><p>character, format of GIS data. To be chosen within "SHP", "GPKG", or "SQL". Default to "SHP".</p></dd> + + <dt>theme</dt> <dd><p>character, themes of BD TOPO to be downloaded when origin is "ign". See details.</p></dd> + + <dt>department</dt> <dd><p>integer, or converted to integer. Departments that should be considered. See details.</p></dd> + + <dt>region</dt> <dd><p>integer, or converted to integer. Regions that should be considered. See details.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="details"> <h2>Details</h2> @@ -158,21 +178,21 @@ successful download.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># WARNING: download everything that is "new".</span></span> -<span class="r-in"><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> </span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2019-03-15"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, region <span class="op">=</span> <span class="fl">11</span>, type <span class="op">=</span> <span class="st">"GPKG"</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># WARNING: download everything related to D034</span></span> -<span class="r-in"><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># WARNING: download everything that is "new".</span></span></span> +<span class="r-in"><span><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span> </span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="st">"2019-03-15"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, region <span class="op">=</span> <span class="fl">11</span>, type <span class="op">=</span> <span class="st">"GPKG"</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># WARNING: download everything related to D034</span></span></span> +<span class="r-in"><span><span class="fu">download_bd_topo</span><span class="op">(</span><span class="va">destination</span>, department <span class="op">=</span> <span class="fl">34</span>, date <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -187,7 +207,7 @@ successful download.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/download_gaspar.html b/docs/reference/download_gaspar.html index ece48bd2b47dfe68a0da4130cf308f85d36c528b..46bf61815e911e45f52eed3a3c4ee34478a0b823 100644 --- a/docs/reference/download_gaspar.html +++ b/docs/reference/download_gaspar.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,35 +89,46 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">download_gaspar</span><span class="op">(</span> - <span class="va">destination</span>, - origin <span class="op">=</span> <span class="st">"georisques"</span>, - name <span class="op">=</span> <span class="st">"gaspar"</span>, - extension <span class="op">=</span> <span class="st">"zip"</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">download_gaspar</span><span class="op">(</span></span> +<span> <span class="va">destination</span>,</span> +<span> origin <span class="op">=</span> <span class="st">"georisques"</span>,</span> +<span> name <span class="op">=</span> <span class="st">"gaspar"</span>,</span> +<span> extension <span class="op">=</span> <span class="st">"zip"</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>destination</dt> <dd><p>character, the address where dara are stocked</p></dd> + + <dt>origin</dt> <dd><p>character, either a keyword or the address from where data are downloaded. Best to keep it at default value.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archive to be downloaded</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archive to be downloaded</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send somme messages while running</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>If everything got fine the <code>download_gaspar</code> returns the + + +<p>If everything got fine the <code>download_gaspar</code> returns the integer 0, if not it returns an object of class "try-error".</p> </div> <div id="details"> @@ -135,11 +145,11 @@ destination as a subirectory of destination.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download_gaspar</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download_gaspar</span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download_gaspar</span><span class="op">(</span><span class="va">tempfile</span>, origin <span class="op">=</span> <span class="st">"opendatarchives"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="va">destination</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download_gaspar</span><span class="op">(</span><span class="va">destination</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download_gaspar</span><span class="op">(</span><span class="va">destination</span>, origin <span class="op">=</span> <span class="st">"cquest"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">download_gaspar</span><span class="op">(</span><span class="va">tempfile</span>, origin <span class="op">=</span> <span class="st">"opendatarchives"</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -154,7 +164,7 @@ destination as a subirectory of destination.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/eaip_variable.html b/docs/reference/eaip_variable.html index 1ea51870d56f0ff7d3fa33435d83f10445492735..96658ef45b37a58224ad0369ec9edb6c0f5952c2 100644 --- a/docs/reference/eaip_variable.html +++ b/docs/reference/eaip_variable.html @@ -20,7 +20,7 @@ information (such as R, V, B)."><meta property="og:image" content="/logo.png"><! </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -34,41 +34,40 @@ information (such as R, V, B)."><meta property="og:image" content="/logo.png"><! <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -96,7 +95,7 @@ information (such as R, V, B).</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">eaip_variable</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">eaip_variable</span></span></code></pre></div> </div> <div id="format"> @@ -116,7 +115,7 @@ information (such as R, V, B).</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/extract.stat.log.html b/docs/reference/extract.stat.log.html index 3b085bfe23d8ba4a1cf812527d51dbb2e621d882..fc9f6a1695a81f9833a05407286bd1d6973417d8 100644 --- a/docs/reference/extract.stat.log.html +++ b/docs/reference/extract.stat.log.html @@ -18,7 +18,7 @@ data.frame. This function gives also the possibility to save those data.frame di </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ data.frame. This function gives also the possibility to save those data.frame di <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,22 +91,29 @@ data.frame. This function gives also the possibility to save those data.frame di </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">extract.stat.log</span><span class="op">(</span><span class="va">origin</span>, archive <span class="op">=</span> <span class="cn">NULL</span>, destination <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">extract.stat.log</span><span class="op">(</span><span class="va">origin</span>, archive <span class="op">=</span> <span class="cn">NULL</span>, destination <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where journal is stored</p></dd> + + <dt>archive</dt> <dd><p>string character, pattern to find the journal. If set to NULL, any .log file will be searched.</p></dd> + + <dt>destination</dt> <dd><p>character, optional path to the directory where results should be saved. If set to NULL, results are not saved.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list of data.frame depending on information stored in the journal.</p> + + +<p>A list of data.frame depending on information stored in the journal.</p> </div> <div id="author"> <h2>Author</h2> @@ -116,12 +122,12 @@ results are not saved.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"floodam.data/dev/data"</span></span> -<span class="r-in"><span class="va">archive</span> <span class="op">=</span> <span class="st">"geo_siret"</span></span> -<span class="r-in"><span class="va">result</span> <span class="op">=</span> <span class="fu">extract.stat.log</span><span class="op">(</span><span class="va">origin</span>, <span class="va">archive</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"floodam.data/dev/data"</span></span></span> +<span class="r-in"><span><span class="va">archive</span> <span class="op">=</span> <span class="st">"geo_siret"</span></span></span> +<span class="r-in"><span><span class="va">result</span> <span class="op">=</span> <span class="fu">extract.stat.log</span><span class="op">(</span><span class="va">origin</span>, <span class="va">archive</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -136,7 +142,7 @@ results are not saved.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/extract_building.html b/docs/reference/extract_building.html index a95ecc5f2f1d95248aff9041df99612d632bcf73..0f998f0c6bf8e7de7eba2eee85b1b475d93ae594 100644 --- a/docs/reference/extract_building.html +++ b/docs/reference/extract_building.html @@ -26,7 +26,7 @@ Result is saved according to 'destination' path."><meta property="og:image" cont </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -40,41 +40,40 @@ Result is saved according to 'destination' path."><meta property="og:image" cont <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -108,46 +107,67 @@ Result is saved according to 'destination' path.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">extract_building</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_bd_topo_3.html">scheme_bd_topo_3</a></span>, - journal <span class="op">=</span> <span class="cn">TRUE</span>, - map <span class="op">=</span> <span class="cn">FALSE</span>, - path_eaip <span class="op">=</span> <span class="cn">NULL</span>, - projection <span class="op">=</span> <span class="fl">4326</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">extract_building</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> scheme <span class="op">=</span> <span class="fu">floodam.data</span><span class="fu">::</span><span class="va"><a href="scheme_bd_topo_3.html">scheme_bd_topo_3</a></span>,</span> +<span> journal <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> map <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> path_eaip <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> projection <span class="op">=</span> <span class="fl">4326</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved.</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated.</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, how archive variables should be treated.</p></dd> + + <dt>journal</dt> <dd><p>logical, should a journal file be saved.</p></dd> + + <dt>map</dt> <dd><p>logical, should a map be plotted (for check purpose).</p></dd> + + <dt>path_eaip</dt> <dd><p>character, path where eaip archives should be find.</p></dd> + + <dt>projection</dt> <dd><p>numeric, 4 digits projection to use.</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -166,7 +186,7 @@ Result is saved according to 'destination' path.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/extract_building_agricultural.html b/docs/reference/extract_building_agricultural.html index 30448da2a54c0dda0861ab6b245d52d0cd0c67cc..2dcac70a7661de4fa53e8e03207a08397e1116f1 100644 --- a/docs/reference/extract_building_agricultural.html +++ b/docs/reference/extract_building_agricultural.html @@ -19,7 +19,7 @@ to agricultural buildings from an sf object that should come from </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ to agricultural buildings from an sf object that should come from <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,38 +93,53 @@ to agricultural buildings from an sf object that should come from </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">extract_building_agricultural</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - journal <span class="op">=</span> <span class="cn">TRUE</span>, - map <span class="op">=</span> <span class="cn">TRUE</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">extract_building_agricultural</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> journal <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> map <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved.</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated.</p></dd> + + <dt>journal</dt> <dd><p>logical, should a journal file be saved.</p></dd> + + <dt>map</dt> <dd><p>logical, should a map be plotted (for check purpose).</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -144,7 +158,7 @@ saved.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/extract_dwelling.html b/docs/reference/extract_dwelling.html index 687ce341f94f6425ab3355d53201c16db270f741..00d23e81e5828916fa6810cf3cf4b7dc33600093 100644 --- a/docs/reference/extract_dwelling.html +++ b/docs/reference/extract_dwelling.html @@ -18,7 +18,7 @@ from an sf object that should come from 'extract_building' use."><meta property= </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ from an sf object that should come from 'extract_building' use."><meta property= <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,41 +91,58 @@ from an sf object that should come from 'extract_building' use.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">extract_dwelling</span><span class="op">(</span> - <span class="va">origin</span>, - <span class="va">destination</span>, - <span class="va">archive</span>, - journal <span class="op">=</span> <span class="cn">TRUE</span>, - map <span class="op">=</span> <span class="cn">TRUE</span>, - department <span class="op">=</span> <span class="cn">NULL</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">extract_dwelling</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> <span class="va">destination</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> journal <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> map <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> department <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved.</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be adpated.</p></dd> + + <dt>journal</dt> <dd><p>logical, should a journal file be saved.</p></dd> + + <dt>map</dt> <dd><p>logical, should a map be plotted (for check purpose).</p></dd> + + <dt>department</dt> <dd><p>character, vector of department that should be treated</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> + + +<p>if retrieve = TRUE, data.frame of adapated data stored in archive.</p> </div> <div id="author"> <h2>Author</h2> @@ -145,7 +161,7 @@ saved.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/fmt.html b/docs/reference/fmt.html index a152fb96026470a70758781846acfe899f3424cc..205cc7d365373d7a28681428bd2d05dc3246f9a0 100644 --- a/docs/reference/fmt.html +++ b/docs/reference/fmt.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,17 +89,20 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">fmt</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">fmt</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>difftime</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>formatted difftime</p> + + +<p>formatted difftime</p> </div> <div id="author"> <h2>Author</h2> @@ -110,10 +112,10 @@ <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">now</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.time</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">after</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.time</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span> <span class="fl">1000</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">fmt</span><span class="op">(</span><span class="va">after</span> <span class="op">-</span> <span class="va">now</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">fmt</span><span class="op">(</span><span class="va">now</span> <span class="op">-</span> <span class="va">after</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">now</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.time</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">after</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.time</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span> <span class="fl">1000</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">fmt</span><span class="op">(</span><span class="va">after</span> <span class="op">-</span> <span class="va">now</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">fmt</span><span class="op">(</span><span class="va">now</span> <span class="op">-</span> <span class="va">after</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -128,7 +130,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/format_archive.html b/docs/reference/format_archive.html index de8e1028856695d2a5695b842954a9356cacc4fd..e34f308e8b192b8a9dc6c19dc3d7f38822796db2 100644 --- a/docs/reference/format_archive.html +++ b/docs/reference/format_archive.html @@ -21,7 +21,7 @@ analyse_archive()."><meta property="og:image" content="/logo.png"><!-- mathjax - </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -35,41 +35,40 @@ analyse_archive()."><meta property="og:image" content="/logo.png"><!-- mathjax - <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -98,21 +97,28 @@ at.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, <span class="va">extension</span>, origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"floodam.data"</span>, <span class="st">"ign"</span>, <span class="st">"version"</span><span class="op">)</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, <span class="va">extension</span>, origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"floodam.data"</span>, <span class="st">"ign"</span>, <span class="st">"version"</span><span class="op">)</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character, a named character.</p></dd> + + <dt>extension</dt> <dd><p>character, if given, it will overrule what is in x.</p></dd> + + <dt>origin</dt> <dd><p>character, default value to "floodam.data". See details.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A vector of formatted names.</p> + + +<p>A vector of formatted names.</p> </div> <div id="details"> <h2>Details</h2> @@ -144,24 +150,24 @@ extension is given, x["extension"] will be used if not NA.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">archive</span> <span class="op">=</span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15.7z"</span></span> -<span class="r-in"><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="analyse_archive.html">analyse_archive</a></span><span class="op">(</span><span class="va">archive</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, origin <span class="op">=</span> <span class="st">"ign"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">archive</span> <span class="op">=</span> <span class="st">"ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15.7z"</span></span></span> +<span class="r-in"><span><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="analyse_archive.html">analyse_archive</a></span><span class="op">(</span><span class="va">archive</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, origin <span class="op">=</span> <span class="st">"ign"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15.7z"</span> -<span class="r-in"><span class="va">archive</span> <span class="op">==</span> <span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, origin <span class="op">=</span> <span class="st">"ign"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="va">archive</span> <span class="op">==</span> <span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, origin <span class="op">=</span> <span class="st">"ign"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] TRUE</span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, extension <span class="op">=</span> <span class="st">"rds"</span>, origin <span class="op">=</span> <span class="st">"ign"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, extension <span class="op">=</span> <span class="st">"rds"</span>, origin <span class="op">=</span> <span class="st">"ign"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "ADMIN-EXPRESS-COG_3-1__SHP_RGAF09UTM20_GLP_2022-04-15.rds"</span> -<span class="r-in"><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, extension <span class="op">=</span> <span class="st">"rds"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, extension <span class="op">=</span> <span class="st">"rds"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "admin-express-cog_2022-04-15.rds"</span> -<span class="r-in"><span class="va">x</span><span class="op">[</span><span class="st">"precision"</span><span class="op">]</span> <span class="op">=</span> <span class="st">"commune"</span></span> -<span class="r-in"><span class="va">x</span><span class="op">[</span><span class="st">"scope"</span><span class="op">]</span> <span class="op">=</span> <span class="st">"D972"</span></span> -<span class="r-in"><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, extension <span class="op">=</span> <span class="st">"rds"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="va">x</span><span class="op">[</span><span class="st">"precision"</span><span class="op">]</span> <span class="op">=</span> <span class="st">"commune"</span></span></span> +<span class="r-in"><span><span class="va">x</span><span class="op">[</span><span class="st">"scope"</span><span class="op">]</span> <span class="op">=</span> <span class="st">"D972"</span></span></span> +<span class="r-in"><span><span class="fu">format_archive</span><span class="op">(</span><span class="va">x</span>, extension <span class="op">=</span> <span class="st">"rds"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "admin-express-cog_commune_D972_2022-04-15.rds"</span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">format_archive</span><span class="op">(</span>origin <span class="op">=</span> <span class="st">"version"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">format_archive</span><span class="op">(</span>origin <span class="op">=</span> <span class="st">"version"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] ".*_.*_.*_.*_.*"</span> </code></pre></div> </div> @@ -177,7 +183,7 @@ extension is given, x["extension"] will be used if not NA.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/format_scope.html b/docs/reference/format_scope.html index 2cde8627a4742067279b7d0be513893820698804..31bb5da1a12e0eec20a72d091b848d425c09e383 100644 --- a/docs/reference/format_scope.html +++ b/docs/reference/format_scope.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,31 +89,42 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">format_scope</span><span class="op">(</span> - <span class="va">x</span>, - type <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"file"</span>, <span class="st">"insee"</span><span class="op">)</span>, - scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"department"</span>, <span class="st">"region"</span><span class="op">)</span>, - origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"department"</span>, <span class="st">"commune"</span><span class="op">)</span>, - check <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">format_scope</span><span class="op">(</span></span> +<span> <span class="va">x</span>,</span> +<span> type <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"file"</span>, <span class="st">"insee"</span><span class="op">)</span>,</span> +<span> scope <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"department"</span>, <span class="st">"region"</span><span class="op">)</span>,</span> +<span> origin <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"department"</span>, <span class="st">"commune"</span><span class="op">)</span>,</span> +<span> check <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>vector of scopes.</p></dd> + + <dt>type</dt> <dd><p>character, either file or something else.</p></dd> + + <dt>scope</dt> <dd><p>character, either department or region.</p></dd> + + <dt>origin</dt> <dd><p>character, either department or commune.</p></dd> + + <dt>check</dt> <dd><p>logical, should check occurs.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>character of formatted scopes</p> + + +<p>character of formatted scopes</p> </div> <div id="author"> <h2>Author</h2> @@ -123,27 +133,27 @@ <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "D001" "D002" "D003" "D004" "D005" "D006" "D007" "D008" "D009" "D010"</span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"insee"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"insee"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "01" "02" "03" "04" "05" "06" "07" "08" "09" "10"</span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, scope <span class="op">=</span> <span class="st">"region"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, scope <span class="op">=</span> <span class="st">"region"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "R01" "R02" "R03" "R04" NA "R06" NA NA NA NA </span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, scope <span class="op">=</span> <span class="st">"region"</span>, check <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, scope <span class="op">=</span> <span class="st">"region"</span>, check <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "R01" "R02" "R03" "R04" "R05" "R06" "R07" "R08" "R09" "R10"</span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"insee"</span>, scope <span class="op">=</span> <span class="st">"region"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"insee"</span>, scope <span class="op">=</span> <span class="st">"region"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "01" "02" "03" "04" NA "06" NA NA NA NA </span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"FR"</span>, <span class="fl">1</span><span class="op">:</span><span class="fl">10</span><span class="op">)</span>, <span class="st">"insee"</span>, scope <span class="op">=</span> <span class="st">"region"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"FR"</span>, <span class="fl">1</span><span class="op">:</span><span class="fl">10</span><span class="op">)</span>, <span class="st">"insee"</span>, scope <span class="op">=</span> <span class="st">"region"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] NA "01" "02" "03" "04" NA "06" NA NA NA NA </span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"2A"</span>, <span class="st">"002B"</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"2A"</span>, <span class="st">"002B"</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "D001" "D002" "D003" "D004" "D005" "D006" "D007" "D008" "D009" "D010"</span> <span class="r-out co"><span class="r-pr">#></span> [11] "D02A" "D02B"</span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"2A"</span>, <span class="st">"002B"</span><span class="op">)</span>, <span class="st">"insee"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="st">"2A"</span>, <span class="st">"002B"</span><span class="op">)</span>, <span class="st">"insee"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "2A" "2B"</span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="st">"R94"</span>, <span class="st">"insee"</span>, <span class="st">"region"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="st">"R94"</span>, <span class="st">"insee"</span>, <span class="st">"region"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "94"</span> -<span class="r-in"><span class="va">commune</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"01125"</span>, <span class="st">"2A123"</span>, <span class="st">"97223"</span>, <span class="st">"97723"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">format_scope</span><span class="op">(</span><span class="va">commune</span>, <span class="st">"insee"</span>, <span class="st">"department"</span>, <span class="st">"commune"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="va">commune</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"01125"</span>, <span class="st">"2A123"</span>, <span class="st">"97223"</span>, <span class="st">"97723"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">format_scope</span><span class="op">(</span><span class="va">commune</span>, <span class="st">"insee"</span>, <span class="st">"department"</span>, <span class="st">"commune"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "01" "2A" "972" NA </span> </code></pre></div> </div> @@ -159,7 +169,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/generate_report.html b/docs/reference/generate_report.html index c66df50da85661a9494e496d9f1ac743e14b2dd0..446dd0d19de9c2b0a308c42cdae0c5b14d9079aa 100644 --- a/docs/reference/generate_report.html +++ b/docs/reference/generate_report.html @@ -18,7 +18,7 @@ for dwelling extracted from BD Topo."><meta property="og:image" content="/logo.p </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ for dwelling extracted from BD Topo."><meta property="og:image" content="/logo.p <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,37 +91,50 @@ for dwelling extracted from BD Topo.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">generate_report</span><span class="op">(</span> - <span class="va">origin</span>, - destination <span class="op">=</span> <span class="va">origin</span>, - <span class="va">archive</span>, - quiet <span class="op">=</span> <span class="cn">FALSE</span>, - template <span class="op">=</span> <span class="st">"dwelling"</span>, - purge <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">generate_report</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> destination <span class="op">=</span> <span class="va">origin</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> quiet <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> template <span class="op">=</span> <span class="st">"dwelling"</span>,</span> +<span> purge <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where output should be saved.</p></dd> + + <dt>archive</dt> <dd><p>either a list with the information to display in the report or a vector of rds filenames containing compressed lists to be processed.</p></dd> + + <dt>quiet</dt> <dd><p>logical, should <code><a href="https://pkgs.rstudio.com/rmarkdown/reference/render.html" class="external-link">rmarkdown::render</a></code> be quiet or not.</p></dd> + + <dt>template</dt> <dd><p>character, either a keyword or the file name for the template to be used.</p></dd> + + <dt>purge</dt> <dd><p>logical, should existing template in destination be removed and, so, a copy from original template in library be copied.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function send some messages while running.</p></dd> + </dl></div> <div id="author"> <h2>Author</h2> @@ -141,7 +153,7 @@ so, a copy from original template in library be copied.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/get_archive.html b/docs/reference/get_archive.html index 78d4b917b17ee2cb635390cb66ab2a9dcdec9bdd..c04f7815f915366d48b69ca48b25cd5d42626db7 100644 --- a/docs/reference/get_archive.html +++ b/docs/reference/get_archive.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,39 +89,52 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">get_archive</span><span class="op">(</span> - <span class="va">origin</span>, - extension <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"zip"</span>, <span class="st">"7z"</span><span class="op">)</span>, - name <span class="op">=</span> <span class="cn">NULL</span>, - date <span class="op">=</span> <span class="cn">NULL</span>, - version <span class="op">=</span> <span class="cn">NULL</span>, - directory <span class="op">=</span> <span class="cn">FALSE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">get_archive</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> extension <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"zip"</span>, <span class="st">"7z"</span><span class="op">)</span>,</span> +<span> name <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> date <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> version <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> directory <span class="op">=</span> <span class="cn">FALSE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, the url address where to find archives.</p></dd> + + <dt>extension</dt> <dd><p>character, vector of acceptable types of archives to be downloaded.</p></dd> + + <dt>name</dt> <dd><p>character, vector of acceptable names fo archives to be downloaded. See details</p></dd> + + <dt>date</dt> <dd><p>character, something like a date that should be used as a filter. See details</p></dd> + + <dt>version</dt> <dd><p>character, something like a version that should be used as a filter.</p></dd> + + <dt>directory</dt> <dd><p>logical, should directories be found instead of archives. See details.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A character vector of all archives or directory found in origin + + +<p>A character vector of all archives or directory found in origin matching with given constraints.</p> </div> <div id="details"> @@ -148,33 +160,33 @@ links finishing by "\" are looked after.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="co"># RPG archive for year 2010 in data.cquest.org</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique/2010"</span></span> -<span class="r-in"><span class="va">file_list</span> <span class="op">=</span> <span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, version <span class="op">=</span> <span class="st">"34"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, version <span class="op">=</span> <span class="fl">30</span><span class="op">:</span><span class="fl">35</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># All RPG archives for any year for region "Occitanie" in data.cquest.org</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="fu">get_archive</span><span class="op">(</span></span> -<span class="r-in"> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique"</span>,</span> -<span class="r-in"> directory <span class="op">=</span> <span class="cn">TRUE</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, version <span class="op">=</span> <span class="st">"R76"</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># "geo_siret" archives in data.cquest.org</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/geo_sirene/v2019/last/dep"</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"gz"</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"geo_siret_34"</span>, <span class="st">"geo_siret_83"</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"gz"</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"geo_siret"</span><span class="op">)</span>, version <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"34"</span>, <span class="st">"83"</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># "ADMIN EXPRESS" archives in ign</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://geoservices.ign.fr/adminexpress"</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"7z"</span>, <span class="st">"ADMIN-EXPRESS-COG"</span>, date <span class="op">=</span> <span class="st">"last"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"7z"</span>, <span class="st">"ADMIN-EXPRESS-COG"</span>, version <span class="op">=</span> <span class="st">"FRA"</span>, date <span class="op">=</span> <span class="st">"last"</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"7z"</span>, <span class="st">"ADMIN-EXPRESS"</span>, date <span class="op">=</span> <span class="fl">2021</span><span class="op">:</span><span class="fl">2022</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="co"># RPG archive for year 2010 in data.cquest.org</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique/2010"</span></span></span> +<span class="r-in"><span><span class="va">file_list</span> <span class="op">=</span> <span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, version <span class="op">=</span> <span class="st">"34"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, version <span class="op">=</span> <span class="fl">30</span><span class="op">:</span><span class="fl">35</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># All RPG archives for any year for region "Occitanie" in data.cquest.org</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="fu">get_archive</span><span class="op">(</span></span></span> +<span class="r-in"><span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique"</span>,</span></span> +<span class="r-in"><span> directory <span class="op">=</span> <span class="cn">TRUE</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, version <span class="op">=</span> <span class="st">"R76"</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># "geo_siret" archives in data.cquest.org</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/geo_sirene/v2019/last/dep"</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"gz"</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"geo_siret_34"</span>, <span class="st">"geo_siret_83"</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"gz"</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"geo_siret"</span><span class="op">)</span>, version <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"34"</span>, <span class="st">"83"</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># "ADMIN EXPRESS" archives in ign</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://geoservices.ign.fr/adminexpress"</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"7z"</span>, <span class="st">"ADMIN-EXPRESS-COG"</span>, date <span class="op">=</span> <span class="st">"last"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"7z"</span>, <span class="st">"ADMIN-EXPRESS-COG"</span>, version <span class="op">=</span> <span class="st">"FRA"</span>, date <span class="op">=</span> <span class="st">"last"</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">get_archive</span><span class="op">(</span><span class="va">origin</span>, <span class="st">"7z"</span>, <span class="st">"ADMIN-EXPRESS"</span>, date <span class="op">=</span> <span class="fl">2021</span><span class="op">:</span><span class="fl">2022</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -189,7 +201,7 @@ links finishing by "\" are looked after.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/gpkg_from_7z.html b/docs/reference/gpkg_from_7z.html index 0e91b24a83aaf295f018c8d494ed0a9d678fc548..9e21a810b1cea16528ba7255b99d729ffc417d7a 100644 --- a/docs/reference/gpkg_from_7z.html +++ b/docs/reference/gpkg_from_7z.html @@ -18,7 +18,7 @@ archive. It looks specifically for a gkpg file inside the 7z archive."><meta pro </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ archive. It looks specifically for a gkpg file inside the 7z archive."><meta pro <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,17 +91,20 @@ archive. It looks specifically for a gkpg file inside the 7z archive.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">gpkg_from_7z</span><span class="op">(</span><span class="va">archive</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">gpkg_from_7z</span><span class="op">(</span><span class="va">archive</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>archive</dt> <dd><p>character, path to the 7z archive.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>charcater, temp path to th gpkg file extracted.</p> + + +<p>charcater, temp path to th gpkg file extracted.</p> </div> <div id="author"> <h2>Author</h2> @@ -121,7 +123,7 @@ archive. It looks specifically for a gkpg file inside the 7z archive.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/in_layer.html b/docs/reference/in_layer.html index e969a9312a51e85174c5c4f94d57f1f84a55960f..6cfba3533149d4593dd452946ffce3623b526f25 100644 --- a/docs/reference/in_layer.html +++ b/docs/reference/in_layer.html @@ -18,7 +18,7 @@ geometry in 'y'."><meta property="og:image" content="/logo.png"><!-- mathjax --> </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ geometry in 'y'."><meta property="og:image" content="/logo.png"><!-- mathjax --> <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,37 +91,50 @@ geometry in 'y'.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">in_layer</span><span class="op">(</span> - <span class="va">x</span>, - <span class="va">y</span>, - treatment <span class="op">=</span> <span class="st">"intersect"</span>, - name <span class="op">=</span> <span class="st">"in_layer"</span>, - divide <span class="op">=</span> <span class="cn">TRUE</span>, - s2 <span class="op">=</span> <span class="cn">FALSE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">in_layer</span><span class="op">(</span></span> +<span> <span class="va">x</span>,</span> +<span> <span class="va">y</span>,</span> +<span> treatment <span class="op">=</span> <span class="st">"intersect"</span>,</span> +<span> name <span class="op">=</span> <span class="st">"in_layer"</span>,</span> +<span> divide <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> s2 <span class="op">=</span> <span class="cn">FALSE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>object that is admissible for st_intersects.</p></dd> + + <dt>y</dt> <dd><p>object that is admissible for st_intersects.</p></dd> + + <dt>treatment</dt> <dd><p>character indicating which treatment should be done. See details.</p></dd> + + <dt>name</dt> <dd><p>character, name that will be used for results. Default to "in_layer".</p></dd> + + <dt>divide</dt> <dd><p>logical, should lwgeom::st_subdivide be used on y to have fast results.</p></dd> + + <dt>s2</dt> <dd><p>logical, should sf_use_s2 be used or not.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>If treatment = "intersect", logical with same length as nrow(x) + + +<p>If treatment = "intersect", logical with same length as nrow(x) indicating whether geometry in x are (event partially) in y. In any other case, data.frame whose column corresponds to asked treaments and rows to geometry in x.</p> @@ -152,33 +164,33 @@ asked, because it is done only one time for both treatments.</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">fun_p1</span> <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">p</span>, <span class="va">n</span>, <span class="va">x</span>, <span class="va">y</span>, <span class="va">s</span> <span class="op">=</span> <span class="fl">0</span><span class="op">)</span><span class="op">{</span></span> -<span class="r-in"> <span class="va">fun</span> <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">p</span>, <span class="va">x</span>, <span class="va">y</span>, <span class="va">s</span><span class="op">)</span> <span class="op">{</span><span class="va">p</span> <span class="op">*</span> <span class="va">s</span> <span class="op">+</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span><span class="op">)</span><span class="op">}</span></span> -<span class="r-in"> <span class="kw">if</span> <span class="op">(</span><span class="va">s</span> <span class="op">==</span> <span class="fl">0</span><span class="op">)</span> <span class="va">s</span> <span class="op">=</span> <span class="fl">1</span> <span class="kw">else</span> <span class="va">s</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="va">s</span></span> -<span class="r-in"> <span class="va">result</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mapply.html" class="external-link">mapply</a></span><span class="op">(</span><span class="va">fun</span>, <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="va">y</span>, <span class="va">s</span>, MoreArgs <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>p <span class="op">=</span> <span class="va">p</span><span class="op">)</span>, SIMPLIFY <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> -<span class="r-in"> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/sfc.html" class="external-link">st_sfc</a></span><span class="op">(</span><span class="va">result</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> -<span class="r-in"><span class="va">fun_p2</span> <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"> <span class="va">theta</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">1</span>, length.out <span class="op">=</span> <span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="fl">2</span> <span class="op">*</span> <span class="va">pi</span></span> -<span class="r-in"> <span class="va">theta</span><span class="op">[</span><span class="va">n</span><span class="op">]</span> <span class="op">=</span> <span class="va">theta</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span></span> -<span class="r-in"> <span class="va">rho</span> <span class="op">=</span> <span class="fl">.8</span> <span class="op">+</span> <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="fl">.2</span></span> -<span class="r-in"> <span class="va">rho</span><span class="op">[</span><span class="va">n</span><span class="op">]</span> <span class="op">=</span> <span class="va">rho</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span></span> -<span class="r-in"> <span class="va">result</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mapply.html" class="external-link">mapply</a></span><span class="op">(</span></span> -<span class="r-in"> <span class="kw">function</span><span class="op">(</span><span class="va">theta</span>, <span class="va">rho</span><span class="op">)</span> <span class="op">{</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/Trig.html" class="external-link">sin</a></span><span class="op">(</span><span class="va">theta</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/Trig.html" class="external-link">cos</a></span><span class="op">(</span><span class="va">theta</span><span class="op">)</span><span class="op">)</span> <span class="op">*</span> <span class="va">rho</span><span class="op">}</span>,</span> -<span class="r-in"> <span class="va">theta</span>,</span> -<span class="r-in"> <span class="va">rho</span>,</span> -<span class="r-in"> SIMPLIFY <span class="op">=</span> <span class="cn">FALSE</span></span> -<span class="r-in"> <span class="op">)</span></span> -<span class="r-in"> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/st.html" class="external-link">st_polygon</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/do.call.html" class="external-link">do.call</a></span><span class="op">(</span><span class="va">rbind</span>, <span class="va">result</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/Random.html" class="external-link">set.seed</a></span><span class="op">(</span><span class="fl">0</span><span class="op">)</span></span> -<span class="r-in"><span class="va">p1</span> <span class="op">=</span> <span class="fu">fun_p2</span><span class="op">(</span><span class="fl">100</span><span class="op">)</span></span> -<span class="r-in"><span class="va">p2</span> <span class="op">=</span> <span class="fu">fun_p2</span><span class="op">(</span><span class="fl">100</span><span class="op">)</span></span> -<span class="r-in"><span class="va">x</span> <span class="op">=</span> <span class="fu">fun_p1</span><span class="op">(</span><span class="va">p1</span> <span class="op">*</span> <span class="fl">.2</span>, <span class="fl">100</span>, <span class="fl">10</span>, <span class="fl">10</span><span class="op">)</span></span> -<span class="r-in"><span class="va">y</span> <span class="op">=</span> <span class="fu">fun_p1</span><span class="op">(</span><span class="va">p1</span>, <span class="fl">25</span>, <span class="fl">10</span>, <span class="fl">10</span>, <span class="fl">.5</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">fun_p1</span> <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">p</span>, <span class="va">n</span>, <span class="va">x</span>, <span class="va">y</span>, <span class="va">s</span> <span class="op">=</span> <span class="fl">0</span><span class="op">)</span><span class="op">{</span></span></span> +<span class="r-in"><span> <span class="va">fun</span> <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">p</span>, <span class="va">x</span>, <span class="va">y</span>, <span class="va">s</span><span class="op">)</span> <span class="op">{</span><span class="va">p</span> <span class="op">*</span> <span class="va">s</span> <span class="op">+</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span><span class="op">)</span><span class="op">}</span></span></span> +<span class="r-in"><span> <span class="kw">if</span> <span class="op">(</span><span class="va">s</span> <span class="op">==</span> <span class="fl">0</span><span class="op">)</span> <span class="va">s</span> <span class="op">=</span> <span class="fl">1</span> <span class="kw">else</span> <span class="va">s</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="va">s</span></span></span> +<span class="r-in"><span> <span class="va">result</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mapply.html" class="external-link">mapply</a></span><span class="op">(</span><span class="va">fun</span>, <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="va">y</span>, <span class="va">s</span>, MoreArgs <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>p <span class="op">=</span> <span class="va">p</span><span class="op">)</span>, SIMPLIFY <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span> +<span class="r-in"><span> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/sfc.html" class="external-link">st_sfc</a></span><span class="op">(</span><span class="va">result</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> +<span class="r-in"><span><span class="va">fun_p2</span> <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span> <span class="va">theta</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">1</span>, length.out <span class="op">=</span> <span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="fl">2</span> <span class="op">*</span> <span class="va">pi</span></span></span> +<span class="r-in"><span> <span class="va">theta</span><span class="op">[</span><span class="va">n</span><span class="op">]</span> <span class="op">=</span> <span class="va">theta</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span></span></span> +<span class="r-in"><span> <span class="va">rho</span> <span class="op">=</span> <span class="fl">.8</span> <span class="op">+</span> <span class="fu"><a href="https://rdrr.io/r/stats/Uniform.html" class="external-link">runif</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span> <span class="op">*</span> <span class="fl">.2</span></span></span> +<span class="r-in"><span> <span class="va">rho</span><span class="op">[</span><span class="va">n</span><span class="op">]</span> <span class="op">=</span> <span class="va">rho</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span></span></span> +<span class="r-in"><span> <span class="va">result</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mapply.html" class="external-link">mapply</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> <span class="kw">function</span><span class="op">(</span><span class="va">theta</span>, <span class="va">rho</span><span class="op">)</span> <span class="op">{</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/Trig.html" class="external-link">sin</a></span><span class="op">(</span><span class="va">theta</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/Trig.html" class="external-link">cos</a></span><span class="op">(</span><span class="va">theta</span><span class="op">)</span><span class="op">)</span> <span class="op">*</span> <span class="va">rho</span><span class="op">}</span>,</span></span> +<span class="r-in"><span> <span class="va">theta</span>,</span></span> +<span class="r-in"><span> <span class="va">rho</span>,</span></span> +<span class="r-in"><span> SIMPLIFY <span class="op">=</span> <span class="cn">FALSE</span></span></span> +<span class="r-in"><span> <span class="op">)</span></span></span> +<span class="r-in"><span> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/st.html" class="external-link">st_polygon</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/do.call.html" class="external-link">do.call</a></span><span class="op">(</span><span class="va">rbind</span>, <span class="va">result</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Random.html" class="external-link">set.seed</a></span><span class="op">(</span><span class="fl">0</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">p1</span> <span class="op">=</span> <span class="fu">fun_p2</span><span class="op">(</span><span class="fl">100</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">p2</span> <span class="op">=</span> <span class="fu">fun_p2</span><span class="op">(</span><span class="fl">100</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">x</span> <span class="op">=</span> <span class="fu">fun_p1</span><span class="op">(</span><span class="va">p1</span> <span class="op">*</span> <span class="fl">.2</span>, <span class="fl">100</span>, <span class="fl">10</span>, <span class="fl">10</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">y</span> <span class="op">=</span> <span class="fu">fun_p1</span><span class="op">(</span><span class="va">p1</span>, <span class="fl">25</span>, <span class="fl">10</span>, <span class="fl">10</span>, <span class="fl">.5</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span><span class="op">)</span></span></span> <span class="r-msg co"><span class="r-pr">#></span> Linking to GEOS 3.10.2, GDAL 3.4.3, PROJ 8.2.0; sf_use_s2() is FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [1] FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [13] FALSE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE TRUE FALSE FALSE</span> @@ -189,11 +201,11 @@ asked, because it is done only one time for both treatments.</p> <span class="r-out co"><span class="r-pr">#></span> [73] FALSE TRUE FALSE FALSE FALSE FALSE FALSE TRUE TRUE FALSE FALSE FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [85] TRUE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE TRUE</span> <span class="r-out co"><span class="r-pr">#></span> [97] FALSE FALSE FALSE FALSE</span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">y</span>, <span class="va">x</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">y</span>, <span class="va">x</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] FALSE TRUE TRUE TRUE FALSE TRUE FALSE FALSE TRUE FALSE TRUE FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [13] TRUE FALSE FALSE FALSE FALSE FALSE TRUE FALSE TRUE TRUE TRUE TRUE</span> <span class="r-out co"><span class="r-pr">#></span> [25] TRUE</span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"intersect"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"intersect"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [13] FALSE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE TRUE FALSE FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [25] FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE</span> @@ -203,7 +215,7 @@ asked, because it is done only one time for both treatments.</p> <span class="r-out co"><span class="r-pr">#></span> [73] FALSE TRUE FALSE FALSE FALSE FALSE FALSE TRUE TRUE FALSE FALSE FALSE</span> <span class="r-out co"><span class="r-pr">#></span> [85] TRUE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE TRUE</span> <span class="r-out co"><span class="r-pr">#></span> [97] FALSE FALSE FALSE FALSE</span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"intersection"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"intersection"</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some elements of y are self-intersecting, results may not be consistent.</span> <span class="r-out co"><span class="r-pr">#></span> in_layer_area</span> <span class="r-out co"><span class="r-pr">#></span> 1 0.000000e+00</span> @@ -306,7 +318,7 @@ asked, because it is done only one time for both treatments.</p> <span class="r-out co"><span class="r-pr">#></span> 98 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 99 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 100 0.000000e+00</span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"proportion"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"proportion"</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some elements of y are self-intersecting, results may not be consistent.</span> <span class="r-out co"><span class="r-pr">#></span> in_layer_prop</span> <span class="r-out co"><span class="r-pr">#></span> 1 0.000000e+00</span> @@ -409,7 +421,7 @@ asked, because it is done only one time for both treatments.</p> <span class="r-out co"><span class="r-pr">#></span> 98 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 99 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 100 0.000000e+00</span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"all"</span>, <span class="st">"y"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"all"</span>, <span class="st">"y"</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some elements of y are self-intersecting, results may not be consistent.</span> <span class="r-out co"><span class="r-pr">#></span> y y_area y_prop</span> <span class="r-out co"><span class="r-pr">#></span> 1 FALSE 0.000000e+00 0.000000e+00</span> @@ -512,7 +524,7 @@ asked, because it is done only one time for both treatments.</p> <span class="r-out co"><span class="r-pr">#></span> 98 FALSE 0.000000e+00 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 99 FALSE 0.000000e+00 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 100 FALSE 0.000000e+00 0.000000e+00</span> -<span class="r-in"><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"all"</span>, <span class="st">"y"</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">y</span>, <span class="st">"all"</span>, <span class="st">"y"</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> y y_area y_prop</span> <span class="r-out co"><span class="r-pr">#></span> 1 FALSE 0.000000e+00 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 2 TRUE 1.024397e-01 9.991605e-01</span> @@ -614,32 +626,32 @@ asked, because it is done only one time for both treatments.</p> <span class="r-out co"><span class="r-pr">#></span> 98 FALSE 0.000000e+00 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 99 FALSE 0.000000e+00 0.000000e+00</span> <span class="r-out co"><span class="r-pr">#></span> 100 FALSE 0.000000e+00 0.000000e+00</span> -<span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">n</span> <span class="op">=</span> <span class="fl">5</span></span> -<span class="r-in"><span class="va">z</span> <span class="op">=</span> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/sfc.html" class="external-link">st_sfc</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">replicate</a></span><span class="op">(</span><span class="va">n</span>, <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/geos_combine.html" class="external-link">st_union</a></span><span class="op">(</span><span class="fu">fun_p1</span><span class="op">(</span><span class="va">p2</span> <span class="op">*</span> <span class="fl">.15</span>, <span class="fl">1000</span>, <span class="fl">10</span>, <span class="fl">10</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="va">z</span> <span class="op">=</span> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/valid.html" class="external-link">st_make_valid</a></span><span class="op">(</span><span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/geos_binary_ops.html" class="external-link">st_difference</a></span><span class="op">(</span><span class="va">z</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">z</span>, col <span class="op">=</span> <span class="fu">scales</span><span class="fu">::</span><span class="fu"><a href="https://scales.r-lib.org/reference/alpha.html" class="external-link">alpha</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/grDevices/palettes.html" class="external-link">rainbow</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span>, <span class="fl">.5</span><span class="op">)</span>, axes <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">x</span>, col <span class="op">=</span> <span class="fu">scales</span><span class="fu">::</span><span class="fu"><a href="https://scales.r-lib.org/reference/alpha.html" class="external-link">alpha</a></span><span class="op">(</span><span class="st">"blue"</span>, <span class="fl">.5</span><span class="op">)</span>, add <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">y</span>, col <span class="op">=</span> <span class="fu">scales</span><span class="fu">::</span><span class="fu"><a href="https://scales.r-lib.org/reference/alpha.html" class="external-link">alpha</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="fl">.5</span><span class="op">)</span>, add <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="fu">microbenchmark</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/microbenchmark/man/microbenchmark.html" class="external-link">microbenchmark</a></span><span class="op">(</span></span> -<span class="r-in"> slow <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span>,</span> -<span class="r-in"> fast <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, divide <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span> -<span class="r-in"> times <span class="op">=</span> <span class="fl">10</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">microbenchmark</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/microbenchmark/man/microbenchmark.html" class="external-link">microbenchmark</a></span><span class="op">(</span></span> -<span class="r-in"> slow <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"intersection"</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span>,</span> -<span class="r-in"> fast <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"intersection"</span>, divide <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span> -<span class="r-in"> times <span class="op">=</span> <span class="fl">10</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="fu">microbenchmark</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/microbenchmark/man/microbenchmark.html" class="external-link">microbenchmark</a></span><span class="op">(</span></span> -<span class="r-in"> slow <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"all"</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span>,</span> -<span class="r-in"> fast <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"all"</span>, divide <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span> -<span class="r-in"> times <span class="op">=</span> <span class="fl">10</span></span> -<span class="r-in"><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">n</span> <span class="op">=</span> <span class="fl">5</span></span></span> +<span class="r-in"><span><span class="va">z</span> <span class="op">=</span> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/sfc.html" class="external-link">st_sfc</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">replicate</a></span><span class="op">(</span><span class="va">n</span>, <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/geos_combine.html" class="external-link">st_union</a></span><span class="op">(</span><span class="fu">fun_p1</span><span class="op">(</span><span class="va">p2</span> <span class="op">*</span> <span class="fl">.15</span>, <span class="fl">1000</span>, <span class="fl">10</span>, <span class="fl">10</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">z</span> <span class="op">=</span> <span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/valid.html" class="external-link">st_make_valid</a></span><span class="op">(</span><span class="fu">sf</span><span class="fu">::</span><span class="fu"><a href="https://r-spatial.github.io/sf/reference/geos_binary_ops.html" class="external-link">st_difference</a></span><span class="op">(</span><span class="va">z</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">z</span>, col <span class="op">=</span> <span class="fu">scales</span><span class="fu">::</span><span class="fu"><a href="https://scales.r-lib.org/reference/alpha.html" class="external-link">alpha</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/grDevices/palettes.html" class="external-link">rainbow</a></span><span class="op">(</span><span class="va">n</span><span class="op">)</span>, <span class="fl">.5</span><span class="op">)</span>, axes <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">x</span>, col <span class="op">=</span> <span class="fu">scales</span><span class="fu">::</span><span class="fu"><a href="https://scales.r-lib.org/reference/alpha.html" class="external-link">alpha</a></span><span class="op">(</span><span class="st">"blue"</span>, <span class="fl">.5</span><span class="op">)</span>, add <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">y</span>, col <span class="op">=</span> <span class="fu">scales</span><span class="fu">::</span><span class="fu"><a href="https://scales.r-lib.org/reference/alpha.html" class="external-link">alpha</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="fl">.5</span><span class="op">)</span>, add <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">microbenchmark</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/microbenchmark/man/microbenchmark.html" class="external-link">microbenchmark</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> slow <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> fast <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, divide <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> times <span class="op">=</span> <span class="fl">10</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">microbenchmark</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/microbenchmark/man/microbenchmark.html" class="external-link">microbenchmark</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> slow <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"intersection"</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> fast <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"intersection"</span>, divide <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> times <span class="op">=</span> <span class="fl">10</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">microbenchmark</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/pkg/microbenchmark/man/microbenchmark.html" class="external-link">microbenchmark</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> slow <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"all"</span>, divide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> fast <span class="op">=</span> <span class="fu">in_layer</span><span class="op">(</span><span class="va">x</span>, <span class="va">z</span>, <span class="st">"all"</span>, divide <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> times <span class="op">=</span> <span class="fl">10</span></span></span> +<span class="r-in"><span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -654,7 +666,7 @@ asked, because it is done only one time for both treatments.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/index.html b/docs/reference/index.html index 9269c48754661096ed697668734827f030a07462..1f5de299a8a97e0b9f5ce980100c33d60bdd5d4f 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -311,6 +310,10 @@ <p><code><a href="naf_label.html">naf_label</a></code> </p> </td> <td><p>Label (in French) coming from NAF typology</p></td> + </tr><tr><td> + <p><code><a href="nomenclature_clc.html">nomenclature_clc</a></code> </p> + </td> + <td><p>Nomenclature of Corine Land Cover with color definitions</p></td> </tr><tr><td> <p><code><a href="nomenclature_rpg_1.html">nomenclature_rpg_1</a></code> </p> </td> @@ -460,7 +463,7 @@ from the INSEE</p></td> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/nace_label.html b/docs/reference/nace_label.html index f7893947f5e3cbc598a51bd622ab22bc44926388..855542f0aa7f12ea66b350590dddbc08e80cb82d 100644 --- a/docs/reference/nace_label.html +++ b/docs/reference/nace_label.html @@ -18,7 +18,7 @@ corresponding with the NACE typology of activities at levels 1 to 4 included.">< </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ corresponding with the NACE typology of activities at levels 1 to 4 included.">< <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ corresponding with the NACE typology of activities at levels 1 to 4 included.</p </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">nace_label</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">nace_label</span></span></code></pre></div> </div> <div id="format"> @@ -125,7 +124,7 @@ code.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/naf_esane.html b/docs/reference/naf_esane.html index e93866f45801c972ef5c00d56da73def50d6ae47..f940931be1f3b302f31818b6be804ea7f402c83e 100644 --- a/docs/reference/naf_esane.html +++ b/docs/reference/naf_esane.html @@ -18,7 +18,7 @@ with some useful additional information from French database esane."><meta prope </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ with some useful additional information from French database esane."><meta prope <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ with some useful additional information from French database esane.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">naf_esane</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">naf_esane</span></span></code></pre></div> </div> <div id="format"> @@ -198,7 +197,7 @@ category.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/naf_label.html b/docs/reference/naf_label.html index eadb1b6f81edce44c1e723793a9397c2a3a5aef7..08fcd15e442419691ce82ae323db64c105a093b1 100644 --- a/docs/reference/naf_label.html +++ b/docs/reference/naf_label.html @@ -18,7 +18,7 @@ the NAF typology of activities at levels 1 to 5 included."><meta property="og:im </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ the NAF typology of activities at levels 1 to 5 included."><meta property="og:im <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ the NAF typology of activities at levels 1 to 5 included.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">naf_label</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">naf_label</span></span></code></pre></div> </div> <div id="format"> @@ -121,7 +120,7 @@ the NAF typology of activities at levels 1 to 5 included.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/nomenclature_clc.html b/docs/reference/nomenclature_clc.html new file mode 100644 index 0000000000000000000000000000000000000000..8a918e121c4b53e5129eb9256b8a946bf9baf8ab --- /dev/null +++ b/docs/reference/nomenclature_clc.html @@ -0,0 +1,150 @@ +<!DOCTYPE html> +<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Nomenclature of Corine Land Cover with color definitions — nomenclature_clc • floodam.data</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Nomenclature of Corine Land Cover with color definitions — nomenclature_clc"><meta property="og:description" content="A dataset containing the labels in French and English corresponding with +the Corine Land Cover (CLC) typology. It also gives color definition for +each types. Those colors are those that may be used internally in +floodam.data and also those given by the French ministrey of environment."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> +<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> +<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + + + <div class="container template-reference-topic"> + <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <span class="navbar-brand"> + <a class="navbar-link" href="../index.html">floodam.data</a> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> + </span> + </div> + + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"><li> + <a href="../reference/index.html">Reference</a> +</li> +<li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> + Articles + + <span class="caret"></span> + </a> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> + <li> + <a href="../articles/download-data.html">Introduction to the library</a> + </li> + <li class="divider"> + <li class="dropdown-header">database (English)</li> + <li> + <a href="../articles/bd_topo_en.html">BD Topo</a> + </li> + <li class="divider"> + <li class="dropdown-header">database (French)</li> + <li> + <a href="../admin_express_fr">Admin Express</a> + </li> + <li> + <a href="../articles/ban_fr.html">BAN</a> + </li> + <li> + <a href="../articles/bd_topo_fr.html">BD Topo</a> + </li> + <li> + <a href="../articles/gaspar_fr.html">Gaspar</a> + </li> + <li> + <a href="../articles/rpg_fr.html">RPG</a> + </li> + <li class="divider"> + <li class="dropdown-header">Processes (English)</li> + <li> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> + </li> + <li class="divider"> + <li> + <a href="../articles/index.html">Other articles</a> + </li> + </ul></li> +<li> + <a href="../news/index.html">Changelog</a> +</li> + </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse --> + </div><!--/.container --> +</div><!--/.navbar --> + + + + </header><div class="row"> + <div class="col-md-9 contents"> + <div class="page-header"> + <h1>Nomenclature of Corine Land Cover with color definitions</h1> + + <div class="hidden name"><code>nomenclature_clc.Rd</code></div> + </div> + + <div class="ref-description"> + <p>A dataset containing the labels in French and English corresponding with +the Corine Land Cover (CLC) typology. It also gives color definition for +each types. Those colors are those that may be used internally in +floodam.data and also those given by the French ministrey of environment.</p> + </div> + + <div id="ref-usage"> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">nomenclature_clc</span></span></code></pre></div> + </div> + + <div id="format"> + <h2>Format</h2> + <p>A data frame with 28 rows and 2 variables:</p><dl><dt>level</dt> +<dd><p>character, level of classification in CLC.</p></dd> + +<dt>clc</dt> +<dd><p>character, classification in CLC.</p></dd> + +<dt>clc_label_fr</dt> +<dd><p>character, label in French corresponding with the +clc code.</p></dd> + +<dt>clc_label_en</dt> +<dd><p>character, label in English corresponding with the +clc code.</p></dd> + +<dt>col</dt> +<dd><p>character, color definition for floodam.data usage.</p></dd> + +<dt>col_fr</dt> +<dd><p>character, color definition by the French ministery of +environment.</p></dd> + + +</dl></div> + + </div> + <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> + <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2> + </nav></div> +</div> + + + <footer><div class="copyright"> + <p></p><p>Developed by Frédéric Grelot, David Nortes Martinez, Pierre Balzergue, Victor Champonnois.</p> +</div> + +<div class="pkgdown"> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> +</div> + + </footer></div> + + + + + + + </body></html> + diff --git a/docs/reference/nomenclature_rpg_1.html b/docs/reference/nomenclature_rpg_1.html index 9df0fc8e45446de6f4f6fec1dc25e41aa592e1ac..6f0a43bb06876a79d54f4b1137a739c47eddb047 100644 --- a/docs/reference/nomenclature_rpg_1.html +++ b/docs/reference/nomenclature_rpg_1.html @@ -18,7 +18,7 @@ the version 1.0 of the RPG typology for cultivated plots."><meta property="og:im </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ the version 1.0 of the RPG typology for cultivated plots."><meta property="og:im <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ the version 1.0 of the RPG typology for cultivated plots.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">nomenclature_rpg_1</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">nomenclature_rpg_1</span></span></code></pre></div> </div> <div id="format"> @@ -119,7 +118,7 @@ group code.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/nomenclature_rpg_2.html b/docs/reference/nomenclature_rpg_2.html index 68943441e71643f44fa4638dd0718de90b4f8349..6d4eb130939ebef8f129a3cfdc80e1dd4b1ed9d4 100644 --- a/docs/reference/nomenclature_rpg_2.html +++ b/docs/reference/nomenclature_rpg_2.html @@ -19,7 +19,7 @@ year 2018)."><meta property="og:image" content="/logo.png"><!-- mathjax --><scri </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ year 2018)."><meta property="og:image" content="/logo.png"><!-- mathjax --><scri <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,7 +93,7 @@ year 2018).</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">nomenclature_rpg_2</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">nomenclature_rpg_2</span></span></code></pre></div> </div> <div id="format"> @@ -124,7 +123,7 @@ the crop code.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/plot_construction_date.html b/docs/reference/plot_construction_date.html index 59a155e32acfab51d70361d118396f8edbed72c8..c5d94eb68e3a3e18a18812ce30c42fdc72148d9d 100644 --- a/docs/reference/plot_construction_date.html +++ b/docs/reference/plot_construction_date.html @@ -21,7 +21,7 @@ image in destination"><meta property="og:image" content="/logo.png"><!-- mathjax </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -35,41 +35,40 @@ image in destination"><meta property="og:image" content="/logo.png"><!-- mathjax <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -97,17 +96,22 @@ image in destination</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">plot_construction_date</span><span class="op">(</span><span class="va">output_name</span>, <span class="va">dataset</span>, <span class="va">destination</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">plot_construction_date</span><span class="op">(</span><span class="va">output_name</span>, <span class="va">dataset</span>, <span class="va">destination</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>output_name</dt> <dd><p>character. It can be either "building" or "dwelling"</p></dd> + + <dt>dataset</dt> <dd><p>data.frame</p></dd> + + <dt>destination</dt> <dd><p>character. Path to folder where tables and figures must be stocked.</p></dd> + </dl></div> <div id="author"> <h2>Author</h2> @@ -126,7 +130,7 @@ image in destination</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/pprn_classification.html b/docs/reference/pprn_classification.html index 40eadd0c6ed8b0fd944e1bcafaa3d11bd7949cc5..a9877617c6c132767f1291a984e3f0299ac55f97 100644 --- a/docs/reference/pprn_classification.html +++ b/docs/reference/pprn_classification.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">pprn_classification</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">pprn_classification</span></span></code></pre></div> </div> <div id="format"> @@ -110,7 +109,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/prepare.stat.log.html b/docs/reference/prepare.stat.log.html index 18f165ac85dfdde7d91b25cf04d45ba21257b177..81c5546619a95d8840c8270909d3c2d3daa6d6fb 100644 --- a/docs/reference/prepare.stat.log.html +++ b/docs/reference/prepare.stat.log.html @@ -18,7 +18,7 @@ time series perspective of those data.frame."><meta property="og:image" content= </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ time series perspective of those data.frame."><meta property="og:image" content= <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,22 +91,29 @@ time series perspective of those data.frame.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">prepare.stat.log</span><span class="op">(</span><span class="va">origin</span>, <span class="va">archive</span>, destination <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">prepare.stat.log</span><span class="op">(</span><span class="va">origin</span>, <span class="va">archive</span>, destination <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where journal is stored</p></dd> + + <dt>archive</dt> <dd><p>string character, pattern to find the journal. If set to NULL, any .log file will be searched.</p></dd> + + <dt>destination</dt> <dd><p>character, optional path to the directory where results should be saved. If set to NULL, results are not saved.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list of data.frame depending on information stored in the journal.</p> + + +<p>A list of data.frame depending on information stored in the journal.</p> </div> <div id="author"> <h2>Author</h2> @@ -116,12 +122,12 @@ results are not saved.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"floodam.data/dev/data"</span></span> -<span class="r-in"><span class="va">archive</span> <span class="op">=</span> <span class="st">"geo_siret"</span></span> -<span class="r-in"><span class="va">result</span> <span class="op">=</span> <span class="fu">prepare.stat.log</span><span class="op">(</span><span class="va">origin</span>, <span class="va">archive</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"floodam.data/dev/data"</span></span></span> +<span class="r-in"><span><span class="va">archive</span> <span class="op">=</span> <span class="st">"geo_siret"</span></span></span> +<span class="r-in"><span><span class="va">result</span> <span class="op">=</span> <span class="fu">prepare.stat.log</span><span class="op">(</span><span class="va">origin</span>, <span class="va">archive</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -136,7 +142,7 @@ results are not saved.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/prepare_table_building.html b/docs/reference/prepare_table_building.html index b7ad93beb3b3243760b5a0740620422add6dabff..98f88ae87916f0939899700ca72e5154595e4b22 100644 --- a/docs/reference/prepare_table_building.html +++ b/docs/reference/prepare_table_building.html @@ -19,7 +19,7 @@ the BDTopo v3."><meta property="og:image" content="/logo.png"><!-- mathjax --><s </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ the BDTopo v3."><meta property="og:image" content="/logo.png"><!-- mathjax --><s <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,20 +93,25 @@ the BDTopo v3.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">prepare_table_building</span><span class="op">(</span><span class="va">dataset</span>, <span class="va">category</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">prepare_table_building</span><span class="op">(</span><span class="va">dataset</span>, <span class="va">category</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>dataset</dt> <dd><p>dataframe.</p></dd> + + <dt>category</dt> <dd><p>character, focus of the analysis. Default value to "Résidentiel".</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list.</p> + + +<p>A list.</p> </div> <div id="author"> <h2>Author</h2> @@ -126,7 +130,7 @@ the BDTopo v3.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/prepare_table_dwelling.html b/docs/reference/prepare_table_dwelling.html index 240ce1b0943fdc1b2a14ce5baa8ce2392c114072..20116cfc3c31349c0658fa65846fa7e00164f961 100644 --- a/docs/reference/prepare_table_dwelling.html +++ b/docs/reference/prepare_table_dwelling.html @@ -19,7 +19,7 @@ BDTopo v3."><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ BDTopo v3."><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,20 +93,25 @@ BDTopo v3.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">prepare_table_dwelling</span><span class="op">(</span><span class="va">dataset</span>, <span class="va">category</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">prepare_table_dwelling</span><span class="op">(</span><span class="va">dataset</span>, <span class="va">category</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>dataset</dt> <dd><p>dataframe.</p></dd> + + <dt>category</dt> <dd><p>character, focus of the analysis. Default value to "Résidentiel".</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A list.</p> + + +<p>A list.</p> </div> <div id="author"> <h2>Author</h2> @@ -126,7 +130,7 @@ BDTopo v3.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/qq_developed_dwelling.html b/docs/reference/qq_developed_dwelling.html index 5cfc4d736faea1d7a57ea8414eee849b979031c8..c12880b97eafcd2183c3508920fb2b5746193b96 100644 --- a/docs/reference/qq_developed_dwelling.html +++ b/docs/reference/qq_developed_dwelling.html @@ -21,7 +21,7 @@ plot is stored as png image in destination"><meta property="og:image" content="/ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -35,41 +35,40 @@ plot is stored as png image in destination"><meta property="og:image" content="/ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -97,19 +96,26 @@ plot is stored as png image in destination</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">qq_developed_dwelling</span><span class="op">(</span><span class="va">output_name</span>, <span class="va">dataset</span>, <span class="va">destination</span>, <span class="va">dwelling_mean_surf</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">qq_developed_dwelling</span><span class="op">(</span><span class="va">output_name</span>, <span class="va">dataset</span>, <span class="va">destination</span>, <span class="va">dwelling_mean_surf</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>output_name</dt> <dd><p>character.</p></dd> + + <dt>dataset</dt> <dd><p>data.frame</p></dd> + + <dt>destination</dt> <dd><p>character. Path to folder where tables and figures must be stocked.</p></dd> + + <dt>dwelling_mean_surf</dt> <dd><p>numeric. Average surface of a dwelling</p></dd> + </dl></div> <div id="author"> <h2>Author</h2> @@ -128,7 +134,7 @@ plot is stored as png image in destination</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/qq_height_level.html b/docs/reference/qq_height_level.html index eff7960c3b3ff1fa7fc858c8c4783525ac5c248d..06401b205883cc9cf3217f625f7c26f78dc1404c 100644 --- a/docs/reference/qq_height_level.html +++ b/docs/reference/qq_height_level.html @@ -21,7 +21,7 @@ that process the bdtopo. The plot is stored as png image in destination"><meta p </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -35,41 +35,40 @@ that process the bdtopo. The plot is stored as png image in destination"><meta p <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -97,17 +96,22 @@ that process the bdtopo. The plot is stored as png image in destination</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">qq_height_level</span><span class="op">(</span><span class="va">output_name</span>, <span class="va">dataset</span>, <span class="va">destination</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">qq_height_level</span><span class="op">(</span><span class="va">output_name</span>, <span class="va">dataset</span>, <span class="va">destination</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>output_name</dt> <dd><p>character.</p></dd> + + <dt>dataset</dt> <dd><p>data.frame</p></dd> + + <dt>destination</dt> <dd><p>character. Path to folder where tables and figures must be stocked.</p></dd> + </dl></div> <div id="author"> <h2>Author</h2> @@ -126,7 +130,7 @@ that process the bdtopo. The plot is stored as png image in destination</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/read_format_rds.html b/docs/reference/read_format_rds.html index 3eee6f325f607c4794fe7486efcca029bbcc6d10..b66f2f093669cea57ec089b1ec22a162d7854e47 100644 --- a/docs/reference/read_format_rds.html +++ b/docs/reference/read_format_rds.html @@ -19,7 +19,7 @@ floodam.data::bd_topo_roof."><meta property="og:image" content="/logo.png"><!-- </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ floodam.data::bd_topo_roof."><meta property="og:image" content="/logo.png"><!-- <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,17 +93,20 @@ floodam.data::bd_topo_roof.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">read_format_rds</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">read_format_rds</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character, path of th archive.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>data.frame</p> + + +<p>data.frame</p> </div> <div id="author"> <h2>Author</h2> @@ -123,7 +125,7 @@ floodam.data::bd_topo_roof.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/read_gpkg_layer.html b/docs/reference/read_gpkg_layer.html index fa55a1e417024132e97cbb836741479e31749646..cadfdfb7a7b935ecdcc3577a9f0468b4f439a98f 100644 --- a/docs/reference/read_gpkg_layer.html +++ b/docs/reference/read_gpkg_layer.html @@ -18,7 +18,7 @@ a gkpg archive."><meta property="og:image" content="/logo.png"><!-- mathjax -->< </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ a gkpg archive."><meta property="og:image" content="/logo.png"><!-- mathjax -->< <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,19 +91,24 @@ a gkpg archive.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">read_gpkg_layer</span><span class="op">(</span><span class="va">path</span>, <span class="va">layer</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">read_gpkg_layer</span><span class="op">(</span><span class="va">path</span>, <span class="va">layer</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>path</dt> <dd><p>character, path where to find the 'gpkg' file.</p></dd> + + <dt>layer</dt> <dd><p>character, layer to be read.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>sf object</p> + + +<p>sf object</p> </div> <div id="author"> <h2>Author</h2> @@ -123,7 +127,7 @@ a gkpg archive.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/read_url.html b/docs/reference/read_url.html index fb04415ff9f3dca80bef4a97bb3c61ddab2c4429..4d535f6f8ebac1c59afc8cffde1b4475e98fa8be 100644 --- a/docs/reference/read_url.html +++ b/docs/reference/read_url.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,28 +89,31 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">read_url</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">read_url</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character string. It should be a complete URL including scheme, as expected in <code><a href="https://rdrr.io/r/base/connections.html" class="external-link">url</a></code>.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>A character vector of length the number of lines read.</p> + + +<p>A character vector of length the number of lines read.</p> </div> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique/"</span></span> -<span class="r-in"><span class="va">year</span> <span class="op">=</span> <span class="st">"2010"</span></span> -<span class="r-in"><span class="va">index</span> <span class="op">=</span> <span class="fu">read_url</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/sprintf.html" class="external-link">sprintf</a></span><span class="op">(</span><span class="st">"%s/%s"</span>, <span class="va">origin</span>, <span class="va">year</span><span class="op">)</span><span class="op">)</span></span> -<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span> -<span class="r-in"><span class="va">origin</span> <span class="op">=</span> <span class="st">"ftp://Admin_Express_ext:Dahnoh0eigheeFok@ftp3.ign.fr/"</span></span> -<span class="r-in"><span class="va">index</span> <span class="op">=</span> <span class="fu">read_url</span><span class="op">(</span><span class="va">origin</span><span class="op">)</span></span> -<span class="r-in"><span class="op">}</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"https://data.cquest.org/registre_parcellaire_graphique/"</span></span></span> +<span class="r-in"><span><span class="va">year</span> <span class="op">=</span> <span class="st">"2010"</span></span></span> +<span class="r-in"><span><span class="va">index</span> <span class="op">=</span> <span class="fu">read_url</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/sprintf.html" class="external-link">sprintf</a></span><span class="op">(</span><span class="st">"%s/%s"</span>, <span class="va">origin</span>, <span class="va">year</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span> +<span class="r-in"><span><span class="va">origin</span> <span class="op">=</span> <span class="st">"ftp://Admin_Express_ext:Dahnoh0eigheeFok@ftp3.ign.fr/"</span></span></span> +<span class="r-in"><span><span class="va">index</span> <span class="op">=</span> <span class="fu">read_url</span><span class="op">(</span><span class="va">origin</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> </code></pre></div> </div> </div> @@ -126,7 +128,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/read_with_scheme.html b/docs/reference/read_with_scheme.html index 3b0d5946e5f20c571593e85c380c3a8290fa653b..20e9af71356d83dc1e8815d89a9a74996cdff672 100644 --- a/docs/reference/read_with_scheme.html +++ b/docs/reference/read_with_scheme.html @@ -44,7 +44,7 @@ read_gpkg_with_scheme.'><meta property="og:image" content="/logo.png"><!-- mathj </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -58,41 +58,40 @@ read_gpkg_with_scheme.'><meta property="og:image" content="/logo.png"><!-- mathj <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -144,47 +143,60 @@ is only one. It then reads the uncompressed gpkg file with a call to </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">read_with_scheme</span><span class="op">(</span> - <span class="va">x</span>, - scheme <span class="op">=</span> <span class="cn">NULL</span>, - projection <span class="op">=</span> <span class="cn">NA</span>, - <span class="va">layer</span>, - <span class="va">type</span>, - extension <span class="op">=</span> <span class="fu">tools</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/tools/fileutils.html" class="external-link">file_ext</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span> -<span class="op">)</span> - -<span class="fu">read_csv_with_scheme</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span><span class="op">)</span> - -<span class="fu">read_shp_with_scheme</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span> - -<span class="fu">read_gpkg_with_scheme</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span> - -<span class="fu">read_shp_from_7z</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span> - -<span class="fu">read_gpkg_from_7z</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">read_with_scheme</span><span class="op">(</span></span> +<span> <span class="va">x</span>,</span> +<span> scheme <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> projection <span class="op">=</span> <span class="cn">NA</span>,</span> +<span> <span class="va">layer</span>,</span> +<span> <span class="va">type</span>,</span> +<span> extension <span class="op">=</span> <span class="fu">tools</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/tools/fileutils.html" class="external-link">file_ext</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span> +<span><span class="op">)</span></span> +<span></span> +<span><span class="fu">read_csv_with_scheme</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">read_shp_with_scheme</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">read_gpkg_with_scheme</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">read_shp_from_7z</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">read_gpkg_from_7z</span><span class="op">(</span><span class="va">x</span>, scheme <span class="op">=</span> <span class="cn">NULL</span>, projection <span class="op">=</span> <span class="cn">NA</span>, <span class="va">layer</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character, path of the data to be read.</p></dd> + + <dt>scheme</dt> <dd><p>data.frame, scheme to be applied.</p></dd> + + <dt>projection</dt> <dd><p>something that will be used in the option "crs" of <code><a href="https://r-spatial.github.io/sf/reference/st_as_sf.html" class="external-link">sf::st_as_sf</a></code>.</p></dd> + + <dt>layer</dt> <dd><p>character, indicates the layer to be read for data organized by layers.</p></dd> + + <dt>type</dt> <dd><p>character, indicates the type of data that should be read.</p></dd> + + <dt>extension</dt> <dd><p>character, indicate the exrtension of the archive. If missing will be guessed from x.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>data adapted, either a data.frame or a 'sf' objects.</p> + + +<p>data adapted, either a data.frame or a 'sf' objects.</p> </div> <div id="details"> <h2>Details</h2> @@ -209,7 +221,7 @@ colClasses set to "character".</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/region.html b/docs/reference/region.html index d265412eb0ff6a81a7bd1c89970c374344161d5b..b93a554524f250bbeff9a58b6f16c808b2bf1e8a 100644 --- a/docs/reference/region.html +++ b/docs/reference/region.html @@ -18,7 +18,7 @@ in France."><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ in France."><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ in France.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">region</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">region</span></span></code></pre></div> </div> <div id="format"> @@ -118,7 +117,7 @@ in France.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/save_archive.html b/docs/reference/save_archive.html index 290f2679c9ee26fd808ae06c10f9de9f87ec6405..46dd9e535d56798f200120eda9ac61608712775d 100644 --- a/docs/reference/save_archive.html +++ b/docs/reference/save_archive.html @@ -18,7 +18,7 @@ those archives for a use in a typical 'floodam.data' perspective."><meta propert </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ those archives for a use in a typical 'floodam.data' perspective."><meta propert <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,29 +91,40 @@ those archives for a use in a typical 'floodam.data' perspective.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="va">path</span>, scope <span class="op">=</span> <span class="cn">NULL</span>, extension <span class="op">=</span> <span class="cn">NULL</span>, origin <span class="op">=</span> <span class="st">"floodam.data"</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="va">path</span>, scope <span class="op">=</span> <span class="cn">NULL</span>, extension <span class="op">=</span> <span class="cn">NULL</span>, origin <span class="op">=</span> <span class="st">"floodam.data"</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>data.frame, data to be archived.</p></dd> + + <dt>path</dt> <dd><p>character, the path from wich the archive's path is constructed. See details.</p></dd> + + <dt>scope</dt> <dd><p>character or factor. If factor or long character, how x will be sliced. If character of length 1, may be the name of a variable of x. See details.</p></dd> + + <dt>extension</dt> <dd><p>character, the extension and so the format to be used for saving. See details.</p></dd> + + <dt>origin</dt> <dd><p>character, default value to "floodam.data". See details.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>Nothin useful.</p> + + +<p>Nothin useful.</p> </div> <div id="details"> <h2>Details</h2> @@ -127,23 +137,23 @@ saving. See details.</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>scope <span class="op">=</span> <span class="fl">0</span><span class="op">:</span><span class="fl">2</span><span class="op">)</span></span> -<span class="r-in"><span class="va">temp_dir</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span> -<span class="r-in"><span class="va">scope</span> <span class="op">=</span> <span class="st">"scope"</span></span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># No scope, no extension, only basename</span></span> -<span class="r-in"><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">temp_dir</span>, <span class="st">"x"</span><span class="op">)</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>scope <span class="op">=</span> <span class="fl">0</span><span class="op">:</span><span class="fl">2</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">temp_dir</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">scope</span> <span class="op">=</span> <span class="st">"scope"</span></span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># No scope, no extension, only basename</span></span></span> +<span class="r-in"><span><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">temp_dir</span>, <span class="st">"x"</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Unmanaged extension. Nothing is saved.</span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># Adding a scope</span></span> -<span class="r-in"><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">temp_dir</span>, <span class="st">"x"</span><span class="op">)</span>, scope <span class="op">=</span> <span class="st">"scope"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># Adding a scope</span></span></span> +<span class="r-in"><span><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">temp_dir</span>, <span class="st">"x"</span><span class="op">)</span>, scope <span class="op">=</span> <span class="st">"scope"</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some levels of scope ar NA. Corresponding data will not be saved.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Unmanaged extension. Nothing is saved.</span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Unmanaged extension. Nothing is saved.</span> -<span class="r-in"></span> -<span class="r-in"><span class="co"># Using a path with extension, but also parameter extension</span></span> -<span class="r-in"><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">temp_dir</span>, <span class="st">"x.7z"</span><span class="op">)</span>, extension <span class="op">=</span> <span class="st">"rds"</span>, scope <span class="op">=</span> <span class="st">"scope"</span><span class="op">)</span></span> +<span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># Using a path with extension, but also parameter extension</span></span></span> +<span class="r-in"><span><span class="fu">save_archive</span><span class="op">(</span><span class="va">x</span>, <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">temp_dir</span>, <span class="st">"x.7z"</span><span class="op">)</span>, extension <span class="op">=</span> <span class="st">"rds"</span>, scope <span class="op">=</span> <span class="st">"scope"</span><span class="op">)</span></span></span> <span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some levels of scope ar NA. Corresponding data will not be saved.</span> </code></pre></div> </div> @@ -159,7 +169,7 @@ saving. See details.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_admin_express_2_0.html b/docs/reference/scheme_admin_express_2_0.html index fce6ed71211d4e5895119db9f9415a70976c97f8..6b6bab7baed793ed6fd42f7dbc6a885fc5e01ef6 100644 --- a/docs/reference/scheme_admin_express_2_0.html +++ b/docs/reference/scheme_admin_express_2_0.html @@ -19,7 +19,7 @@ for old version of Admin Express."><meta property="og:image" content="/logo.png" </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ for old version of Admin Express."><meta property="og:image" content="/logo.png" <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,7 +93,7 @@ for old version of Admin Express.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_admin_express_2_0</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_admin_express_2_0</span></span></code></pre></div> </div> <div id="format"> @@ -148,7 +147,7 @@ data.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_admin_express_3_1.html b/docs/reference/scheme_admin_express_3_1.html index 1e567b0d38e07ff784b4c8f79a25781548cf59f0..76dff335b33fa31bbb6271761503f2aa5235352c 100644 --- a/docs/reference/scheme_admin_express_3_1.html +++ b/docs/reference/scheme_admin_express_3_1.html @@ -19,7 +19,7 @@ adapt_admin_express."><meta property="og:image" content="/logo.png"><!-- mathjax </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ adapt_admin_express."><meta property="og:image" content="/logo.png"><!-- mathjax <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,7 +93,7 @@ their desired type. It is used as default value in </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_admin_express_3_1</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_admin_express_3_1</span></span></code></pre></div> </div> <div id="format"> @@ -148,7 +147,7 @@ data.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_ban.html b/docs/reference/scheme_ban.html index 72bffa89d4613e790f7cc183b7e29f5a6816e0ab..a464d243c9eae384229642184c7eddc15edef255 100644 --- a/docs/reference/scheme_ban.html +++ b/docs/reference/scheme_ban.html @@ -18,7 +18,7 @@ their desired type. It is used as default value in adapt_ban."><meta property="o </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ their desired type. It is used as default value in adapt_ban."><meta property="o <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ their desired type. It is used as default value in adapt_ban.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_ban</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_ban</span></span></code></pre></div> </div> <div id="format"> @@ -144,7 +143,7 @@ variable.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_bd_topo_3.html b/docs/reference/scheme_bd_topo_3.html index df348e844a08eed3e5c9bc30533ea3f3baebb451..9dfd3b6d97d9ebe630a14f652b8f0d1b23d4b4fa 100644 --- a/docs/reference/scheme_bd_topo_3.html +++ b/docs/reference/scheme_bd_topo_3.html @@ -18,7 +18,7 @@ their desired type. It is used as default value in adapt.bd_topo."><meta propert </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ their desired type. It is used as default value in adapt.bd_topo."><meta propert <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ their desired type. It is used as default value in adapt.bd_topo.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_bd_topo_3</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_bd_topo_3</span></span></code></pre></div> </div> <div id="format"> @@ -154,7 +153,7 @@ variable.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_gaspar_azi.html b/docs/reference/scheme_gaspar_azi.html index bfc5b4afc62cf72969e0a3288c3c11e87712c890..02ab655fe407b997280e00e585f7248d99832983 100644 --- a/docs/reference/scheme_gaspar_azi.html +++ b/docs/reference/scheme_gaspar_azi.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_gaspar_azi</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_gaspar_azi</span></span></code></pre></div> </div> <div id="format"> @@ -110,7 +109,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_gaspar_catnat.html b/docs/reference/scheme_gaspar_catnat.html index 11f363d41420cae4851a6d54eccf1c404c9b3876..dc87719355de77f9ffdc89ea01b46ba0e3fb523e 100644 --- a/docs/reference/scheme_gaspar_catnat.html +++ b/docs/reference/scheme_gaspar_catnat.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_gaspar_catnat</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_gaspar_catnat</span></span></code></pre></div> </div> <div id="format"> @@ -110,7 +109,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_gaspar_pprn.html b/docs/reference/scheme_gaspar_pprn.html index d8319ac1da700df0a28b6ffe6c17af45d66aeaad..66cacf1f139f1e3f3fd332ba2d9c273d05392de1 100644 --- a/docs/reference/scheme_gaspar_pprn.html +++ b/docs/reference/scheme_gaspar_pprn.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_gaspar_pprn</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_gaspar_pprn</span></span></code></pre></div> </div> <div id="format"> @@ -110,7 +109,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_gaspar_risq.html b/docs/reference/scheme_gaspar_risq.html index 58f100a20d7c296f34ca3bf22e2bfea7887f32a2..798930c17ffc9b8c33f5913978b45ee8c8777358 100644 --- a/docs/reference/scheme_gaspar_risq.html +++ b/docs/reference/scheme_gaspar_risq.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_gaspar_risq</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_gaspar_risq</span></span></code></pre></div> </div> <div id="format"> @@ -110,7 +109,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_insee_logement_2019.html b/docs/reference/scheme_insee_logement_2019.html index dc5e1a60cbcb88be4b8cd07dfc516cc86eb3be93..50c74ee005e87cf89486fc33c5b1d7652b03e714 100644 --- a/docs/reference/scheme_insee_logement_2019.html +++ b/docs/reference/scheme_insee_logement_2019.html @@ -20,7 +20,7 @@ their desired type. It is used as default value in adapt_insee."><meta property= </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -34,41 +34,40 @@ their desired type. It is used as default value in adapt_insee."><meta property= <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -95,7 +94,7 @@ their desired type. It is used as default value in adapt_insee.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_insee_logement_2019</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_insee_logement_2019</span></span></code></pre></div> </div> <div id="format"> @@ -146,7 +145,7 @@ data.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_rpg_1.html b/docs/reference/scheme_rpg_1.html index 7eb05a58c5d4ba1c26b283432cc34e4ffaccf62c..121bee83f9e265326849fb67a1e26521104a7ad9 100644 --- a/docs/reference/scheme_rpg_1.html +++ b/docs/reference/scheme_rpg_1.html @@ -18,7 +18,7 @@ their desired type. It is used as default value in adapt_rpg."><meta property="o </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ their desired type. It is used as default value in adapt_rpg."><meta property="o <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ their desired type. It is used as default value in adapt_rpg.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_rpg_1</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_rpg_1</span></span></code></pre></div> </div> <div id="format"> @@ -146,7 +145,7 @@ data.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_rpg_2.html b/docs/reference/scheme_rpg_2.html index 874d5d736a2cb5343cb707d8d8992bc6b33643be..1552564d304fddc77b58d783e5ff4754f125d5fc 100644 --- a/docs/reference/scheme_rpg_2.html +++ b/docs/reference/scheme_rpg_2.html @@ -18,7 +18,7 @@ their desired type. It is used as default value in adapt_rpg."><meta property="o </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ their desired type. It is used as default value in adapt_rpg."><meta property="o <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ their desired type. It is used as default value in adapt_rpg.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_rpg_2</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_rpg_2</span></span></code></pre></div> </div> <div id="format"> @@ -146,7 +145,7 @@ data.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_sirene_2019.html b/docs/reference/scheme_sirene_2019.html index 51f80befd8d7271c8465dace61587346e17c4265..a36ae648c308972bc28892456a481bd08c8ab347 100644 --- a/docs/reference/scheme_sirene_2019.html +++ b/docs/reference/scheme_sirene_2019.html @@ -22,7 +22,7 @@ adapt.geo_sirene."><meta property="og:image" content="/logo.png"><!-- mathjax -- </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -36,41 +36,40 @@ adapt.geo_sirene."><meta property="og:image" content="/logo.png"><!-- mathjax -- <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -100,7 +99,7 @@ adapt.geo_sirene.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_sirene_2019</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_sirene_2019</span></span></code></pre></div> </div> <div id="format"> @@ -151,7 +150,7 @@ data.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/scheme_sirene_na.html b/docs/reference/scheme_sirene_na.html index 0fe5a7d2ec67a51f44760f10fa50ddabb72749c0..2963b07b1ddc5c0da7d0dc41c10ef1a4bda587cb 100644 --- a/docs/reference/scheme_sirene_na.html +++ b/docs/reference/scheme_sirene_na.html @@ -18,7 +18,7 @@ geolocalized sirene data. It is used as default value in adapt.geo_sirene.'><met </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ geolocalized sirene data. It is used as default value in adapt.geo_sirene.'><met <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,7 +91,7 @@ geolocalized sirene data. It is used as default value in adapt.geo_sirene.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="va">scheme_sirene_na</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="va">scheme_sirene_na</span></span></code></pre></div> </div> <div id="format"> @@ -118,7 +117,7 @@ geolocalized sirene data. It is used as default value in adapt.geo_sirene.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/send_message.html b/docs/reference/send_message.html index 2f6bb22254a11b900b7bff58a5cf70a895860037..4392061430762a5c9ec267fda6c29bd88d7c1f61 100644 --- a/docs/reference/send_message.html +++ b/docs/reference/send_message.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,7 +89,7 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">send_message</span><span class="op">(</span><span class="va">...</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">send_message</span><span class="op">(</span><span class="va">...</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> @@ -99,20 +98,25 @@ <dd><p>zero or more objects which can be coerced to character (and which are pasted together with no separator) or (for message only) a single condition object.character, the message to be sent.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the message be sent.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>nothing</p> + + +<p>nothing</p> </div> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="fu">send_message</span> <span class="op">(</span><span class="st">"This is not a useful message"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="fu">send_message</span> <span class="op">(</span><span class="st">"This is not a useful message"</span><span class="op">)</span></span></span> <span class="r-msg co"><span class="r-pr">#></span> This is not a useful message</span> -<span class="r-in"><span class="fu">send_message</span> <span class="op">(</span><span class="st">"This is not a useful message"</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">send_message</span> <span class="op">(</span><span class="st">"This is not a useful message"</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span> </code></pre></div> </div> </div> @@ -127,7 +131,7 @@ single condition object.character, the message to be sent.</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/shp_from_7z.html b/docs/reference/shp_from_7z.html index f69b3069ef3dd1f674a1844fa33182b4f100c670..5d66d472f6c81bac1e2de80bb509350a14881e60 100644 --- a/docs/reference/shp_from_7z.html +++ b/docs/reference/shp_from_7z.html @@ -18,7 +18,7 @@ archive. It looks specifically for a shp file inside the 7z archive."><meta prop </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -32,41 +32,40 @@ archive. It looks specifically for a shp file inside the 7z archive."><meta prop <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -92,17 +91,20 @@ archive. It looks specifically for a shp file inside the 7z archive.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">shp_from_7z</span><span class="op">(</span><span class="va">archive</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">shp_from_7z</span><span class="op">(</span><span class="va">archive</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>archive</dt> <dd><p>character, path to the 7z archive.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>charcater, temp path to th shp file extracted.</p> + + +<p>charcater, temp path to th shp file extracted.</p> </div> <div id="author"> <h2>Author</h2> @@ -121,7 +123,7 @@ archive. It looks specifically for a shp file inside the 7z archive.</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/summarise_dwelling.html b/docs/reference/summarise_dwelling.html index 96237dcafa1b4d95084b924e63f98e71636fea5d..85ff184085680032722bb843b4ce39bb1f6606e2 100644 --- a/docs/reference/summarise_dwelling.html +++ b/docs/reference/summarise_dwelling.html @@ -19,7 +19,7 @@ dwellings are included for a structured typlogy used inside the function."><meta </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -33,41 +33,40 @@ dwellings are included for a structured typlogy used inside the function."><meta <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -94,39 +93,54 @@ dwellings are included for a structured typlogy used inside the function.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">summarise_dwelling</span><span class="op">(</span> - <span class="va">origin</span>, - destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"synthesis"</span><span class="op">)</span>, - <span class="va">archive</span>, - flood <span class="op">=</span> <span class="cn">NULL</span>, - graph <span class="op">=</span> <span class="cn">TRUE</span>, - retrieve <span class="op">=</span> <span class="cn">FALSE</span>, - verbose <span class="op">=</span> <span class="cn">TRUE</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">summarise_dwelling</span><span class="op">(</span></span> +<span> <span class="va">origin</span>,</span> +<span> destination <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/file.path.html" class="external-link">file.path</a></span><span class="op">(</span><span class="va">origin</span>, <span class="st">"synthesis"</span><span class="op">)</span>,</span> +<span> <span class="va">archive</span>,</span> +<span> flood <span class="op">=</span> <span class="cn">NULL</span>,</span> +<span> graph <span class="op">=</span> <span class="cn">TRUE</span>,</span> +<span> retrieve <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> verbose <span class="op">=</span> <span class="cn">TRUE</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>origin</dt> <dd><p>character, path to the directory where archive are stored.</p></dd> + + <dt>destination</dt> <dd><p>character, path to the directory where results should be saved.</p></dd> + + <dt>archive</dt> <dd><p>character, vector of archive to be summarised.</p></dd> + + <dt>flood</dt> <dd><p>character, name of column that give it dwellings are in a flood area. This column should be of type logical.</p></dd> + + <dt>graph</dt> <dd><p>logical, should graphs be plotted.</p></dd> + + <dt>retrieve</dt> <dd><p>logical, should the result be returned.</p></dd> + + <dt>verbose</dt> <dd><p>logical, should the function give some sumup informations.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>if retrieve = TRUE, data.frame of summarised data.</p> + + +<p>if retrieve = TRUE, data.frame of summarised data.</p> </div> <div id="details"> <h2>Details</h2> @@ -155,7 +169,7 @@ graphs have been plotted. If "flood" is not given, the reference is "all".</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/to_logical.html b/docs/reference/to_logical.html index 9ce0e645c526305bbc39fa0985fab196412ff3cb..007b29d1729f836da77b5b8c65307ea3c1ced818 100644 --- a/docs/reference/to_logical.html +++ b/docs/reference/to_logical.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,21 +89,28 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">to_logical</span><span class="op">(</span><span class="va">x</span>, true <span class="op">=</span> <span class="cn">TRUE</span>, false <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">to_logical</span><span class="op">(</span><span class="va">x</span>, true <span class="op">=</span> <span class="cn">TRUE</span>, false <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>character vector</p></dd> + + <dt>true</dt> <dd><p>character, modality for TRUE</p></dd> + + <dt>false</dt> <dd><p>character, modality for FALSE</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>logical vector</p> + + +<p>logical vector</p> </div> <div id="author"> <h2>Author</h2> @@ -113,10 +119,10 @@ <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span>, <span class="fl">10</span>, replace <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">to_logical</span><span class="op">(</span><span class="va">x</span>, <span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span>, <span class="fl">10</span>, replace <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">to_logical</span><span class="op">(</span><span class="va">x</span>, <span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] TRUE TRUE TRUE TRUE TRUE TRUE FALSE TRUE TRUE TRUE</span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">to_logical</span><span class="op">(</span><span class="va">x</span>, <span class="st">"red"</span>, <span class="st">"green"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">to_logical</span><span class="op">(</span><span class="va">x</span>, <span class="st">"red"</span>, <span class="st">"green"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] TRUE TRUE TRUE TRUE TRUE TRUE NA TRUE TRUE TRUE</span> </code></pre></div> </div> @@ -132,7 +138,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/reference/treat_na.html b/docs/reference/treat_na.html index 5c7780a042daff4d812849cd2c582af5be0e16e0..23db32b933f26aec53a7ed2d64b4e641bb625a0f 100644 --- a/docs/reference/treat_na.html +++ b/docs/reference/treat_na.html @@ -17,7 +17,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">floodam.data</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.35.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.9.36.0</span> </span> </div> @@ -31,41 +31,40 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li class="divider"> - <li class="dropdown-header">Introduction</li> + <ul class="dropdown-menu" role="menu"><li class="dropdown-header">Introduction</li> <li> - <a href="../articles/download-data.html">How to use floodam.data for downloads</a> + <a href="../articles/download-data.html">Introduction to the library</a> </li> <li class="divider"> - <li class="dropdown-header">database (En)</li> + <li class="dropdown-header">database (English)</li> <li> <a href="../articles/bd_topo_en.html">BD Topo</a> </li> <li class="divider"> - <li class="dropdown-header">database (Fr)</li> + <li class="dropdown-header">database (French)</li> <li> - <a href="../articles/admin_express_fr.html">Admin express (French)</a> + <a href="../admin_express_fr">Admin Express</a> </li> <li> - <a href="../articles/ban_fr.html">BAN (French)</a> + <a href="../articles/ban_fr.html">BAN</a> </li> <li> - <a href="../articles/bd_topo_fr.html">BD Topo (French)</a> + <a href="../articles/bd_topo_fr.html">BD Topo</a> </li> <li> - <a href="../articles/gaspar_fr.html">gaspar (French)</a> + <a href="../articles/gaspar_fr.html">Gaspar</a> </li> <li> - <a href="../articles/rpg_fr.html">rpg database</a> + <a href="../articles/rpg_fr.html">RPG</a> </li> <li class="divider"> - <li class="dropdown-header">Processes (En)</li> + <li class="dropdown-header">Processes (English)</li> <li> - <a href="../articles/bd_topo_dwelling_en.html">Dwelling from BD Topo (building)</a> + <a href="../articles/bd_topo_dwelling_en.html">From BD Topo to dwelling</a> </li> <li class="divider"> <li> - <a href="../articles/index.html">More articles...</a> + <a href="../articles/index.html">Other articles</a> </li> </ul></li> <li> @@ -90,19 +89,24 @@ </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="va">value</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="va">value</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>vector</p></dd> + + <dt>value</dt> <dd><p>value that shall be replaced by NA</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>vector</p> + + +<p>vector</p> </div> <div id="author"> <h2>Author</h2> @@ -111,12 +115,12 @@ <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span>, <span class="fl">10</span>, replace <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="st">"red"</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">x</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"red"</span>, <span class="st">"blue"</span><span class="op">)</span>, <span class="fl">10</span>, replace <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="st">"red"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] NA "blue" "blue" NA NA "blue" NA "blue" NA "blue"</span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="st">"blue"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="st">"blue"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "red" NA NA "red" "red" NA "red" NA "red" NA </span> -<span class="r-in"><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="st">"green"</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">floodam.data</span><span class="fu">:::</span><span class="fu">treat_na</span><span class="op">(</span><span class="va">x</span>, <span class="st">"green"</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] "red" "blue" "blue" "red" "red" "blue" "red" "blue" "red" "blue"</span> </code></pre></div> </div> @@ -132,7 +136,7 @@ </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> </footer></div> diff --git a/docs/sitemap.xml b/docs/sitemap.xml index d2a79afbad9787d07aae21fdf9b139ae08ddf59b..d4de0e5083e185d26043a595caee0f40a8e07ad8 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -252,6 +252,9 @@ <url> <loc>/reference/naf_label.html</loc> </url> + <url> + <loc>/reference/nomenclature_clc.html</loc> + </url> <url> <loc>/reference/nomenclature_rpg_1.html</loc> </url> diff --git a/inst/extdata/nomenclature_clc.csv b/inst/extdata/nomenclature_clc.csv new file mode 100644 index 0000000000000000000000000000000000000000..4d52cabb7b24303a0079bf5c8cf70912fb1a6eaf --- /dev/null +++ b/inst/extdata/nomenclature_clc.csv @@ -0,0 +1,65 @@ +level,clc,clc_label_fr,clc_label_en,col,col_fr +1,1,Territoires artificialisés,Artificial surfaces,#CD000033,#E6004D +1,2,Territoires agricoles,Agricultural areas,#A2CD5A33,#FFFFA8 +1,3,Forêts et milieux semi-naturels,Forest and semi natural areas,#00640033,#80FF00 +1,4,Zones humides,Wetlands,#4C90B433,#A6A6FF +1,5,Surfaces en eau,Water bodies,#ADD8E633,#00CCF2 +2,11,Zones urbanisées,Urban fabric,#E6004D33,#E6004D +2,12,Zones industrielles ou commerciales et réseaux de communication,"Industrial, commercial and transport units",#CC4DF233,#CC4DF2 +2,13,"Mines, décharges et chantiers","Mine, dump and construction sites",#A600CC33,#A600CC +2,14,"Espaces verts artificialisés, non agricoles","Artificial, non-agricultural vegetated areas",#FFA6FF33,#FFA6FF +2,21,Terres arables,Arable land,#FFFFA833,#FFFFA8 +2,22,Cultures permanentes,Permanent crops,#E6800033,#E68000 +2,23,Prairies,Pastures,#E6E64D33,#E6E64D +2,24,Zones agricoles hétérogènes,Heterogeneous agricultural areas,#FFE6A633,#FFE6A6 +2,31,Forêts,Forests,#80FF0033,#80FF00 +2,32,Milieux à végétation arbustive et/ou herbacée,Scrub and/or herbaceous vegetation associations,#CCF24D33,#CCF24D +2,33,"Espaces ouverts, sans ou avec peu de végétation",Open spaces with little or no vegetation,#E6E6E633,#E6E6E6 +2,41,Zones humides intérieures,Inland wetlands,#A6A6FF33,#A6A6FF +2,42,Zones humides côtières,Coastal wetlands,#CCCCFF33,#CCCCFF +2,51,Eaux continentales,Inland waters,#00CCF233,#00CCF2 +2,52,Eaux maritimes,Marine waters,#00FFA633,#00FFA6 +3,111,Tissu urbain continu,Continuous urban fabric,#E6004D33,#E6004D +3,112,Tissu urbain discontinu,Discontinuous urban fabric,#FF000033,#FF0000 +3,121,Zones industrielles ou commerciales et installations publiques,Industrial or commercial units and public facilities,#CC4DF233,#CC4DF2 +3,122,Réseaux routier et ferroviaire et espaces associés,Road and rail networks and associated land,#CC000033,#CC0000 +3,123,Zones portuaires,Port areas,#E6CCCC33,#E6CCCC +3,124,Aéroports,Airports,#E6CCE633,#E6CCE6 +3,131,Extraction de matériaux,Mineral extraction sites,#A600CC33,#A600CC +3,132,Décharges,Dump sites,#A64D0033,#A64D00 +3,133,Chantiers,Construction sites,#FF4DFF33,#FF4DFF +3,141,Espaces verts urbains,Green urban areas,#FFA6FF33,#FFA6FF +3,142,Équipements sportifs et de loisirs,Sport and leisure facilities,#FFE6FF33,#FFE6FF +3,211,Terres arables hors périmètres d'irrigation,Non-irrigated arable land,#FFFFA833,#FFFFA8 +3,212,Périmètres irrigués en permanence,Permanently irrigated land,#FFFF0033,#FFFF00 +3,213,Rizières,Rice fields,#E6E60033,#E6E600 +3,221,Vignobles,Vineyards,#E6800033,#E68000 +3,222,Vergers et petits fruits,Fruit trees and berry plantations,#F2A64D33,#F2A64D +3,223,Oliveraies,Olive groves,#E6A60033,#E6A600 +3,231,Prairies et autres surfaces toujours en herbe à usage agricole,"Pastures, meadows and other permanent grasslands under agricultural use",#E6E64D33,#E6E64D +3,241,Cultures annuelles associées à des cultures permanentes,Annual crops associated with permanent crops,#FFE6A633,#FFE6A6 +3,242,Systèmes culturaux et parcellaires complexes,Complex cultivation patterns,#FFE64D33,#FFE64D +3,243,"Surfaces essentiellement agricoles, interrompues par des espaces naturels importants","Land principally occupied by agriculture, with significant areas of natural vegetation",#E6CC4D33,#E6CC4D +3,244,Territoires agroforestiers,Agro-forestry areas,#F2CCA633,#F2CCA6 +3,311,Forêts de feuillus,Broad-leaved forest,#80FF0033,#80FF00 +3,312,Forêts de conifères,Coniferous forest,#00A60033,#00A600 +3,313,Forêts mélangées,Mixed forest,#4DFF0033,#4DFF00 +3,321,Pelouses et pâturages naturels,Natural grasslands,#CCF24D33,#CCF24D +3,322,Landes et broussailles,Moors and heathland,#A6FF8033,#A6FF80 +3,323,Végétation sclérophylle,Sclerophyllous vegetation,#A6E64D33,#A6E64D +3,324,Forêt et végétation arbustive en mutation,Transitional woodland-shrub,#A6F20033,#A6F200 +3,331,"Plages, dunes et sable","Beaches, dunes, sands",#E6E6E633,#E6E6E6 +3,332,Roches nues,Bare rocks,#CCCCCC33,#CCCCCC +3,333,Végétation clairsemée,Sparsely vegetated areas,#CCFFCC33,#CCFFCC +3,334,Zones incendiées,Burnt areas,#00000033,#000000 +3,335,Glaciers et neiges éternelles,Glaciers and perpetual snow,#A6E6CC33,#A6E6CC +3,411,Marais intérieurs,Inland marshes,#A6A6FF33,#A6A6FF +3,412,Tourbières,Peat bogs,#4D4DFF33,#4D4DFF +3,421,Marais maritimes,Coastal salt marshes,#CCCCFF33,#CCCCFF +3,422,Marais salants,Salines,#E6E6FF33,#E6E6FF +3,423,Zones intertidales,Intertidal flats,#A6A6E633,#A6A6E6 +3,511,Cours et voies d'eau,Water courses,#00CCF233,#00CCF2 +3,512,Plans d'eau,Water bodies,#80F2E633,#80F2E6 +3,521,Lagunes littorales,Coastal lagoons,#00FFA633,#00FFA6 +3,522,Estuaires,Estuaries,#A6FFE633,#A6FFE6 +3,523,Mers et océans,Sea and ocean,#E6F2FF33,#E6F2FF diff --git a/man/nomenclature_clc.Rd b/man/nomenclature_clc.Rd new file mode 100644 index 0000000000000000000000000000000000000000..ebd21ee6fb028cc365c65ab443729616143ecac1 --- /dev/null +++ b/man/nomenclature_clc.Rd @@ -0,0 +1,30 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{nomenclature_clc} +\alias{nomenclature_clc} +\title{Nomenclature of Corine Land Cover with color definitions} +\format{ +A data frame with 28 rows and 2 variables: +\describe{ +\item{level}{character, level of classification in CLC.} +\item{clc}{character, classification in CLC.} +\item{clc_label_fr}{character, label in French corresponding with the +clc code.} +\item{clc_label_en}{character, label in English corresponding with the +clc code.} +\item{col}{character, color definition for floodam.data usage.} +\item{col_fr}{character, color definition by the French ministery of +environment.} +} +} +\usage{ +nomenclature_clc +} +\description{ +A dataset containing the labels in French and English corresponding with +the Corine Land Cover (CLC) typology. It also gives color definition for +each types. Those colors are those that may be used internally in +floodam.data and also those given by the French ministrey of environment. +} +\keyword{datasets} diff --git a/vignettes/admin_express_fr.Rmd b/vignettes/admin_express_fr.Rmd index 0d958afd97a89d97f469456a10b43b6209fde0fb..126fe104a770a88207da4ebf6c6cda54447115d6 100644 --- a/vignettes/admin_express_fr.Rmd +++ b/vignettes/admin_express_fr.Rmd @@ -1,6 +1,6 @@ --- title: "Admin express (French)" -author: " " +author: "David Nortes Martinez" date: "2023-01-27" output: rmarkdown::html_vignette vignette: >