Usage
API guide
  • Coming Soon
Quick Nav

Codequiry Usage Guide

Welcome to the platform usage guide. The goal of this guide is to give you all the information you need to use Codequiry in a proper manner and to make full use from the features provided. You may click below to skip to relevant sections or use the sidebar to your left.

All about the account

Before you start checking assignments for plagiarism, you will need to create an account. To do this you may visit the link below to signup.

Creating an account

When creating an account you will need to enter basic information such as your name, email, and password. This information is never shared with anyone and its purposes are to assign ownership of your data as well as keep in touch with you if you wish to recieve notifications about assignments.

You may change your account information anytime located under "Account Settings" on the top right menu of your dashboard.

Start exploring

Once your account is created it's time to start exploring and getting familiar with the dashboard layout. Before we can start checking source code for potential plagiarism you will need to proceed to the instructions below.

Getting started with Codequiry

Don't worry we're almost there. Just a few more quick steps and you will be on your way to ensuring a fair academic enviornment!

Courses and creating your first course

The first action to take after creating your account is to visit the dashboard home page and create a course. A course is merely a way for you to organize the assignments you wish to check under a sort of 'folder'. This step is self explanatory, just click on New course on the top right of your page. You will be prompted to name the course (minimum of 3 characters).

Once you have created a course, navigate to the newly created course to enter it.

Assignments and creating your first assignment

The next step is creating an assignment. Similar to courses, this is merely a way for you to submit your source code in a organized manner. When you have entered into a course, click the top right button on your page called "New assignment". Once you have done this, you may enter a name for the assignment and select a profile for the assignment (default option is to 'Create a new profile').

Assignment Profile

If you are creating an assignment for the first time, your account will not have any profiles. So you must create a new profile when creating an assignment. Once completed you will be automatically redirected to the assignment profile page of the assignment when you enter into the assignment. The profile assignment contains settings which you may configure for the purposes of checking submissions.

Selecting a source language

Before checking you are required to select a source language. This is the programming langauge which you intend to check. When selecting a certain language the checker will parse only the files for that selected language, for instance, if you select Java as your language, only .java files will be parsed for similarity checking.

Do I have to worry about base code?

You do not have to worry about providing base source code, as scores will be returned in a both raw and normalized manner.

Uploading submissions

This step is the most important, as if it is done incorrectly, your checks will return errors. When you have completed and saved your assignment profile successfully, you may navigate to the submissions tab of the assignment. Once here, you will have a panel in which you may drop your assignments to upload them.

Before uploading, some important information about your files

Please note that for each submission, you must provide a .ZIP file containing all the source code for that submission. This means if you have 10 submissions you wish to check, you will need to upload 10 individual .ZIP files containing the source files for those submissions. Providing a .ZIP file containing more than one submission will NOT work, it will be counted as one submission! Also ensure that your submissions contain at least one file for the parseable language, for instance, if selected Java each submission must have at least one .java file contained inside the .ZIP file.

It's time to start checking submissions for plagiarism

Once you have ensured you have followed the instructions and are ready to check your assignment. You may click the "Start checking assignments" button located in the Submissions tab of your assignment. See below for more information about assignment checking.

Checking your submissions

Congratulations, you have completed everything required to start checking, your results are almost here. This section will explain the various check types you may run with your submissions.

Peer Check

The peer check is the default required test, which will check all provided submissions against each other for similarity. This test yields local similarity results within the grouped submissions.

Database Check

The database check will additionally check all provided submissions against a database of over 100 million sources of code from public repositories as well as Codequiry's proprietary code database.

Web Check

The web check will additionally check all provided submissions against 2 billion sources live on the web. This includes popular sites of code copying such as Stackoverflow.

Once you have selected the tests you wish to run, you can start the checking process! Depending on the amount of submissions and code provided, as well as server load your assignment checking speed will vary. However, you should expect results instantly or within minutes.

Interpreting the checking results

Now that your assignment has been successfully checked, it's time to breakdown those results so you can understand how to interpret the data and visualizations. You will find two new pages available for viewing, "Overview" and "Results". Below you will find more information on what you will see in these pages and how to interpret what you are seeing.

    Overview

    The overview page will show you a birds eye view of similarity and scores for local checking (Peer Check).

  • Cluster Graph

    A big part of this page is taken up by the cluster graph, which gives you a nice visual representation of how similar submissions are to one another. The big thing to spot here is the distance between submissions. This shows how similar overall the submission is. An instant red flag is a cluster of submissions, which can potentially show collaboration or sharing of code.

  • Score Bar Chart

    The score bar chart displays all submissions with their highest comparison score shown.

  • Similarity Table

    The similarity table shows all comparisons made with the similarity score for each submission comparison. You can sort through by the highest similarity to see potential peer code plagiarism.

  • Results

    The results page is the place to see a submission's results in detail. You will be able to see highlighted matches as well as matches from Peer, Database, and Web Check.

  • File Viewer

    The file viewer allows you to cycle through parsed source code files along with highlighted matches.

  • Match Explorer

    The match explorer will display all matches found for the current selected file. Peer matches are displayed first along with a similarity score, then database matches, and then web matches. Clicking a match will open the file side by side with the match found, if it is a web match you will also be provided with the URL of the web page found.

  • Result Scores

    You will be able to see the overall scores for the selected submission such as the maximum, average, peer, database, and web scores. These scores are very open to interpretation, however we do our best to provide insight into the details of the score according to statistics performed for the assignment.

  • Source Makeup

    The source makeup pie chart will given an overall estimate of the composition makeup for the selected submission. It includes the percentage of original content, peer matched content, database matched content, and web matched content. This is only an estimate and may not be accurate, so you will need to examine in more detail if the percentages seem alarming.

All data from checking results should be taken with a grain of salt. Codequiry never guarantees if a submission has been plagiarised, it is up to the person performing the tests to determine if the submission has, in fact, been plagiarised. Percentages and scores are an estimate according to our similarity threshold and do not represent actual values.

Supercharge your Codequiry experience with Pro