Skip to content

Commit 1c914b6

Browse files
author
AlvarBer
committed
Minor doc improvements
1 parent 0b76147 commit 1c914b6

File tree

5 files changed

+55
-4
lines changed

5 files changed

+55
-4
lines changed

docs/Makefile

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ MARKDOWN := introduction.md state_of_the_art.md workflow.md milestones.md \
44
postmortem.md # Markdown files
55
MARKDOWN_COMPLUTENSE := introduction.md focus.md state_of_the_art.md \
66
workflow.md milestones.md risk_analysis.md interface.md implementation.md \
7-
type_checking.md postmortem.md
7+
type_checking.md analysis.md postmortem.md
88
APPENDICES := package_organization.md how.md # Appendix after bibliography
99
METADATA := metadata.yaml # Metadata files (Author, Date, Title, etc..)
1010
BIBLIOGRAPHY := persimmon.bib # BibLaTeX bibliography
@@ -42,6 +42,15 @@ complutense: $(MARKDOWN_COMPLUTENSE) $(APPENDIX) $(TEMPLATE) $(IMAGES) $(BIBLIOG
4242
--metadata titlepic:images/fdi.png $(METADATA) $(MARKDOWN_COMPLUTENSE) \
4343
--include-after-body $(APPENDIX) -o $(PDF)
4444

45+
twocol: $(MARKDOWN) $(APPENDIX) $(TEMPLATE) $(IMAGES) $(BIBLIOGRAPHY) $(CSL) $(METADATA)
46+
pandoc --smart --standalone --latex-engine xelatex --template $(TEMPLATE) \
47+
--bibliography $(BIBLIOGRAPHY) --csl $(CSL) --table-of-contents \
48+
--top-level-division chapter --metadata date:"$(shell date +%Y/%m/%d)" \
49+
--metadata sansfont:"Helvetica Neue LT Com" -H table.tex \
50+
--metadata classoption:'twocolumn' \
51+
$(METADATA) $(MARKDOWN) --include-after-body $(APPENDIX) -o test.pdf
52+
53+
4554
# For standalone images
4655
images/%.pdf: graphs/%.tex
4756
xelatex $< > /dev/null

docs/src/analysis.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Analysis
2+
========
3+
4+
Raw Data
5+
--------
6+
There were 167 out of 664 malformed `.xml` files. By removing the low level
7+
log entries the number of malformed dropped to 12. This sessions have either a
8+
final high level entry that is incomplete or a single unclosed tag. The most
9+
appropiate procedure is to discard these.
10+
11+
Initial
12+
-------
13+
Before performing some initial analysis on the general characteristics of the
14+
raw data because of the nature of the data much preprocessing is needed.
15+
16+
The data comes as a single `.xml` file per session, they contain all the
17+
low-level inputs and high-level actions by the player in a chronological order.
18+
19+
The events that best represent the flow of the game and that will be used are
20+
the high level ones.
21+
For *La Dama Boba* the set, inc, and event type tells the score of the different
22+
measures found on the game.
23+
24+
There are two strategies to tackle the data, one is getting the final values
25+
of these measures and treat them as parameters, making it easy to collect and
26+
save all the sessions on a single `.csv` files.
27+
28+
But because set events stablish a initial value and the inc, dec alter the
29+
value the most appropriate strategy for treating the data is to take it as a
30+
time series, this makes sense as there is autocorrelation between observations.
31+
In turn a series of additional challenges appear, such that the space between
32+
time measurements is not even (Although it could be transformed to do so),
33+
the need for a cross-validation technique that takes into account time series,
34+
etc...

docs/src/implementation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Implementation
22
==============
3+
<!-- High level overview + low level overview -->
34

45

56
First Iteration

docs/src/interface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Interface Design
22
================
33

4-
Color Palette
5-
-------------
4+
Colour Palette
5+
--------------
66

77
Typography
88
----------

docs/src/milestones.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
Milestones
22
==========
33

4-
54
In order to guarantee the delivery of the software a incremental software
65
development has been chosen, this implies breaking down the objectives into
76
smaller milestones that can be reached more easily, so in case the last
87
milestone is not reached there is still a substantial product to submit.
98

9+
10+
Tree
11+
----
12+
1013
![Milestones Tree](images/objectives.pdf)
1114

1215
**Capped** is more than a minimum viable product, a extensive proof-of-concept,
@@ -32,6 +35,10 @@ integration that means the system would be accessible from a website interface,
3235
and script **synthesization**, which is the opposite of compilation, meaning
3336
the ability to visualize on persimmon a python source file.
3437

38+
Gantt Diagram
39+
-------------
40+
41+
3542
With the settled milestones a Gantt diagram of the project development can be
3643
drawn.
3744

0 commit comments

Comments
 (0)