Autor/a: <nombre del autor> uvus:<uvus del autor>
Aquí debes añadir la descripción del dataset y un enunciado del dominio del proyecto.
- /src: Contiene los diferentes módulos de Python que conforman el proyecto.
- <modulo1.py>: Describe aquí el módulo principal.
- <modulo1_test.py>: Describe aquí el módulo de pruebas.
- <modulo2.py>: Añade descripciones para el resto de módulos que pueda tener tu proyecto. Por ejemplo, sería conveniente tener un módulo separado con funciones genéricas para dibujar gráficas y/o otro con funciones genéricas de conversión de tipos.
- /data: Contiene el dataset o datasets del proyecto
- <dataset1.csv>: Añade una descripción genérica del dataset.
- <dataset2.csv>: Añade una descripción del resto de datasets que puedas tener.
Aquí debes describir la estructura del dataset explicando qué representan los datos que contiene y la descripción de cada una de las columnas.
El dataset está compuesto por <N> columnas, con la siguiente descripción:
- <columna 1>: de tipo <tipo>, representa....
- <columna 2>: de tipo <tipo>, representa.... ....
Descrbe aquí la o las namedtuple que defines en tu proyecto.
Añade aquí descripciones genéricas de las funciones, que luego debes acompañar con comentarios de tipo documentación en el código
- <funcion 1>: Descripción de la función 1.
- <funcion 2>: Descripción de la función 2.
- ...
- <test funcion 1>: Descripción de las pruebas realizadas a la función 1.
- <test funcion 2>: Descripción de las pruebas realizadas a la función 2.
- ...
- <funcion 1>: Descripción de la función 1.
- <funcion 2>: Descripción de la función 2.
- ...