From f963367c018f627f48b9afadbd0a0695c9497507 Mon Sep 17 00:00:00 2001
From: zoonalink <zoonalink@gmail.com>
Date: Tue, 27 Dec 2022 23:16:02 +0000
Subject: [PATCH] Task1 - updated formatting
---
UFCFVQ-15-M_Programming_Task_1_submit.ipynb | 33 +++++++++++++--------
1 file changed, 20 insertions(+), 13 deletions(-)
diff --git a/UFCFVQ-15-M_Programming_Task_1_submit.ipynb b/UFCFVQ-15-M_Programming_Task_1_submit.ipynb
index 084d383..a31576a 100644
--- a/UFCFVQ-15-M_Programming_Task_1_submit.ipynb
+++ b/UFCFVQ-15-M_Programming_Task_1_submit.ipynb
@@ -41,12 +41,13 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {
"deletable": false
},
"source": [
- "### Requirement FR1 - Develop a function to find the arithmetic mean"
+ "### <font color = 'orange'>Requirement FR1</font> - Develop a function to find the arithmetic mean"
]
},
{
@@ -98,12 +99,13 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {
"deletable": false
},
"source": [
- "### Requirement FR2 - Develop a function to read a single column from a CSV file"
+ "### <font color = 'orange'>Requirement FR2</font> - Develop a function to read a single column from a CSV file"
]
},
{
@@ -166,12 +168,13 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {
"deletable": false
},
"source": [
- "### Requirement FR3 - Develop a function to read CSV data from a file into memory"
+ "### <font color = 'orange'>Requirement FR3</font> - Develop a function to read CSV data from a file into memory"
]
},
{
@@ -224,12 +227,13 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {
"deletable": false
},
"source": [
- "### Requirement FR4 - Develop a function to calculate the Pearson Correlation Coefficient for two named columns"
+ "### <font color = 'orange'>Requirement FR4</font> - Develop a function to calculate the Pearson Correlation Coefficient for two named columns"
]
},
{
@@ -312,12 +316,13 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {
"deletable": false
},
"source": [
- "### Requirement FR5 - Develop a function to generate a set of Pearson Correlation Coefficients for a given data file "
+ "### <font color = 'orange'>Requirement FR5</font> - Develop a function to generate a set of Pearson Correlation Coefficients for a given data file "
]
},
{
@@ -372,12 +377,13 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {
"deletable": false
},
"source": [
- "### Requirement FR6 - Develop a function to print a custom table"
+ "### <font color = 'orange'>Requirement FR6</font> - Develop a function to print a custom table"
]
},
{
@@ -516,14 +522,15 @@
]
},
{
+ "attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
- "### <b> Introduction </b>\n",
+ "### <font color = 'gold'><b> Introduction </b></font>\n",
"\n",
"The purpose of this report is to provide a short, critical self-assessment of my code development process for Task 1 of the coursework for `UFCFVQ-15-M Programming_for_Data_Science`. \n",
"\n",
- "### <b> Code Description </b>\n",
+ "### <b><font color = 'gold'> Code Description </font></b>\n",
"Task_1 requires writing functions in order, to ultimately calculate Pearson’s Correlation Coefficients (PCCs) for pairs of variables in a given data file, without using imported Python libraries, and printing a decent-looking table. \n",
"\n",
"Functional requirements (FRs):\n",
@@ -540,7 +547,7 @@
"The code was developed in a Jupyter notebook using a Python 3.11 kernel. \n",
"\n",
"\n",
- "### <b> Development Process</b>\n",
+ "### <b> <font color = 'gold'>Development Process</b></font>\n",
"\n",
"My development process made use of the task’s inherent structure, allowing me to plan, develop and test each FR independently, before combining as needed. This was especially useful for more complex FRs, which required significant iteration and testing before achieving the desired results.\n",
"\n",
@@ -551,7 +558,7 @@
" \n",
"I made conscious use of “new-to-me” tools and techniques like Git, VS_Code, Jupyter notebooks, Markdown.\n",
"\n",
- "### <b> Code Evaluation </b>\n",
+ "### <b> <font color = 'gold'>Code Evaluation </b></font>\n",
"Overall, I am pleased with my code - functions achieve the requirements (as interpreted) and they <i>feel</i> efficient and robust. \n",
"\n",
"Principles in mind when writing functions:\n",
@@ -561,12 +568,12 @@
"* Unambiguous, self-explanatory naming of functions and variables\n",
"* Helpful comments/docstrings by balancing approaches like DRY (Don’t Repeat Yourself), WET (Write Everything Twice), KISS (Keep it Simple, Stupid)\n",
"\n",
- "#### <b> Strengths </b> \n",
+ "#### <b><font color = 'gold'> Strengths</font> </b> \n",
"* Well-commented, functioning code\n",
"* Consistent Git use for version control\n",
"* Kept working notes\n",
"\n",
- "#### <b> Improvements / To-do </b>\n",
+ "#### <b> <font color = 'gold'>Improvements / To-do </font></b>\n",
"* Perhaps over-commented; erred on side of caution\n",
"* Establish preferred naming convention – camelCase, snake_case\n",
"* Learn Python conventions \n",
@@ -576,7 +583,7 @@
"[Archived reflective notes by task](archived\\Task1_FR_reflections.md)\n",
"\n",
"\n",
- "#### <b> Summary </b>\n",
+ "#### <b> <font color = 'gold'>Summary</font> </b>\n",
"I found this task both appealing and beneficial. It allowed me to build a useful function from the ground up, making use of different Python coding techniques and data structures whilst also employing version control and applying appropriate metadata to the code.\n",
"\n",
"I am super-keen to keep learning for my personal and professional development, picking up best practice, standard approaches and avoiding pitfalls. This task allowed me to practice all of this. \n",
--
GitLab