-
Notifications
You must be signed in to change notification settings - Fork 1
/
documentation.txt
37 lines (26 loc) · 2.74 KB
/
documentation.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Here is a small reference of the methods to easily access and visualise the SkillTree data.
## Marks methods that currently present issues
DATA METHODS:
UserData:
count_users: Takes a dictionary as a parameter to specify which users to count. If left empty, it will return the total number of SkillTree users.
timezone_counter: Returns a dictionary whose keys are the timezones and whose values are the amount of users. Takes optional parameter.
number_skills_completed_dict: Returns a dictionary with the amount of skills completed as a key and the number of people who have completed those skills as a value.
number_skills_completed_data: Returns information regarding how many skills users complete.
SkillData:
order_skills_by_popularity: Returns an ordered dictionary with each skill as a key and its number of completions as a value. It takes the optional user_parameter parameter to generate a list for specific types of users.
get_skill_completion_rate: Returns an ordered dictionary whose key is the id of each skill, and whose value is a dictionary containing the amount of users that have started, that are in progress and that have completed each skill, along with a score (indicating, from 0 to 1, the completion rate of the skill). Accepts parameters for skill and users.
list_skills_by_ease: Returns a dictionary with each skill and its completion rate
ChallengeData:
order_challenges_by_popularity: Returns an ordered dictionary with each challenge as a key and its number of completions as a value. It takes the optional user_parameter parameter to generate a list for specific types of users.
GRAPH METHODS:
Note: for all graphs there exists a parameter called tight_layout, which, if set to False deactivates layout optimisation. This can be used if the plots are not displaying properly.
UserGraph:
graph_xp_distribution: Returns a graph with a distribution of users' xp, using a logarithmic scale.
pie_timezones: Pie chart of the different timezones
bar_timezones: Bar chart of the different timezones
## graph_number_skills_completed: To be constructed
SkillGraph:
graph_skills_by_popularity: Returns a horizontal bar chart of the most popular skills. It takes an optional user_parameter parameter to specify which types of users to analyse and an amount parameter, to specify the amount of skills to graph (note, if graph_all is set to True, all skills will be displayed).
## graph_skills_by_ease: Graphs skills by ease. Can take parameter.
ChallengeGraph:
graph_challenges_by_popularity: Returns a horizontal bar chart of the most popular challenges. It takes an optional user_parameter parameter to specify which types of users to analyse and an amount parameter, to specify the amount of skills to graph (note, if graph_all is set to True, all skills will be displayed).