Coordinación interna del Área de Planeación Colaborativa del Laboratorio Nacional de Ciencias de la Sostenibilidad.
View the Project on GitHub lancis-apc/planeacion-colaborativa
Objetivo: Establecer los estándares de calidad y cadena de custodia de los activos de información que se entregan por parte de los colaboradores y usuarios del Área de Planeación Colaborativa (APC).
Alcance: Este protocolo aplica para la información derivada de la entrega y generación de activos de información en donde intervienen los colaboradores internos y externos del APC.
Este protocolo se divide en los siguientes activos de información:
Para la recepción de información geográfica ver “Protocolo de manejo de información geográfica”
De las reglas más importantes a seguir son:
La codificación de los archivos para bases de datos, gráficas, mapas tiene que ser UTF-8
Para realizar la entrega de información de bases de datos se deberá llenar el formulario
Las gráficas entregadas se hacen en el lenguaje de programación R, en el entorno RStudio, Inc. Y se utiliza la librería “ggplot2”.
No aplica
Consultar el protocolo de organización de activos de información en la sección “Nombre de las carpetas y archivos de cualquier activo de información”
Utilizar solo minúsculas, sin espacios y con guión bajo para separar las palabras
El nombre del archivo debe de comenzar con el prefijo bd_ seguido de un nombre corto y claro y al finalizar la fecha (diamesaño)
La codificación del banco de datos deberá estar en UTF-8
Utilizar solo letras minúsculas y número
Máximo 10 caracteres
Tiene que ser indicativo de los datos contenidos en el campo
Debe iniciar con letras (excepto “ñ”)
No debe haber espacios entre palabras, para su separación se emplea guión bajo (_)
Si el campo está relacionado con alguna referencia temporal, esta se agrega al final del nombre, 4 caracteres para un año
No debe contener caracteres especiales como: ‘ % # ¿ entre otros
En el formulario de entrega de información, sección “Metadatos”, en “Tabla de atributos” se tiene que llenar con el nombre del campo, las unidades y la descripción.
Para realizar la entrega de información de bases de datos se deberá llenar el formulario por cada entrega:
Mediante este formulario se notifica la entrega al responsable de los activos de información y al coordinador.
El responsable de los activos de información confirmará la recepción y revisión de los mismos mediante correo electrónico.
Cuando los datos sean revisados y validados se comunicará por correo electrónico la aprobación de la información.
Bajo ninguna excepción se recibirá información sin el formulario de Entrega de activos de información.
Descripción de los campos obligatorios del formulario de Entrega de activos de información:
En la primera sección se tiene que escribir el nombre de quien envía la información con sus respectivos datos de dependencia, contacto telefónico y correo electrónico.
Información confidencial. Indicar si es confidencial o no.
Proyecto. Escoger el proyecto para el que se va enviar información.
Tipo de archivo. Seleccionar el formato de archivos de la información a entregar.
Título de la información. Enunciado que sintetiza la información enviada.
Tabla de atributos. Especificar el nombre de la columna, las unidades de medida y la descripción de los datos de la columna.
Metodología. Método de obtención y procesamiento de la información.
Fecha de toma de datos (inicio). Fecha en la que se inició la toma de datos.
Fecha de toma de datos (fin). Fecha en la que se concluyó la toma de datos.
Localización geográfica de la información. Extensión espacial de la información.
Autor o Creador. Persona u organización responsable de la creación del contenido intelectual de la información. Por ejemplo, los autores en el caso de documentos escritos; artistas, fotógrafos e ilustradores en el caso de recursos visuales.
Cita oficial. Cita textual que pide la fuente de los datos.
Las gráficas entregadas se hacen en el lenguaje de programación R, en el entorno RStudio, Inc. Y se utiliza la librería “ggplot2”.
Las gráficas entregadas estarán en fondo blanco sin la retícula con las siguientes características:
Dependiendo del tipo de gráfica, algunas de las características pueden ser opcionales. El tipo de letra de títulos, leyendas y valores puede ser en Arial o Times New Roman.
Para gráficas que se utilizarán en las presentaciones para el Anfiteatro, el tamaño de letra de los textos y valores deberá ser entre 24 a 36 pt. dependiendo del número de elementos y la proporción del tipo de texto (títulos, leyendas y valores).
La imagen de la gráfica estará en formato png con un ancho de 950 pixeles mínimo, y de alto, el número de pixeles que el programa ponga automáticamente, y/o pdf en tamaño carta, con orientación horizontal.
Las gráficas tienen que ser entregadas junto con el markdown y HTML correspondiente, con la información completa de la gráfica y la cadena de custodia de los datos, de acuerdo a protocolo, ver
ORGANIZACION_APC/apc_iso/protocolos/ protocolo_gr_ma_html
La entrega de mapas puede ser de dos tipos:
3.1 Mapas para informe
Los elementos mínimos que tiene que contener un mapa para informe son:
El estilo de la fuente de la letra tiene que ser “Calibri” y el tamaño dependerá del tipo de elemento del mapa.
3.2 Mapas interactivos en la web
La visualización de los mapas interactivos en la web tiene que ser esquemático y los elementos mínimos que se necesita son:
Los scripts de programación en R, deben cumplir con los siguientes parámetros para su entrega.
Los nombres de los archivos deberán ser claros y relevantes y llevar la extensión .R
El nombramiento de los archivos tiene que ser en minúsculas, sin espacios, sin acentos y sin caracteres especiales, ver Procedimiento de Organización General, en:
ORGANIZACIÓN_APC/apc_iso/procedimientos/procedimiento_organizacion_general.md
Ej. CORRECTO: calcular_encharcamientos.R
La manera preferente de asignar nombres a las variables en con minúsculas y separados con un punto (nombre.variable). Los nombres de las funciones deben tener mayúsculas al inicio (NombreFuncion). Las constantes se nombran como las funciones pero deben contener una k al inicio.
4.1 Variables
Ej. CORRECTO : prom.enchar
4.2 Nombre de funciones
Ej. CORRECTO : CalcularPromedioEnchar
4.3 Nombre de constantes
Ej. CORRECTO : kNombreConstante
La longitud máxima por línea es de 80 caracteres
Utilizar dos espacios. No utilizar tabulador.
Utilizar espacios alrededor de todos los operadores binarios (=, +, -,<-, etc.)
No poner espacios antes de las comas, pero siempre habrá un espacio después de la coma
Ej. CORRECTO : total <- sum(x[ , 1])
Una apertura de llaves nunca debe ir sola en una línea; un cierre de llave debe ir siempre en una línea independiente
Si todos utilizan este esquema general de orden, se facilitará el entendimiento y legibilidad del código:
Comentarios sobre derechos de autor
Comentarios del autor
Descripción general del archivo
Descripción de las librerías (library())
Definición de funciones
Documentar el código es muy importante. Los comentarios deben comenzar con # y un espacio.
La definición de las funciones debe listar primero a los argumentos sin valores por defecto y después a aquellos valores por defecto
Ej. CORRECTO : PredecirEnchar <- function (colonia, precipitación, días, show.plot = TRUE)
No aplica