Skip to content

Commit

Permalink
Minor section restructuring in README
Browse files Browse the repository at this point in the history
  • Loading branch information
PabRod committed Jun 27, 2023
1 parent c2735fd commit 073b0d5
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ library(kinematics)

And we are ready to go!

## Basic usage
## In a nutshell

### In a nutshell
#### Input
This package takes trajectories and returns a whole set of kinematical features.
### Input

The input is a data frame like the one below (see subsection _Movement and how to store it_ below):

Expand All @@ -93,7 +93,7 @@ The input is a data frame like the one below (see subsection _Movement and how t
| $t_3$ | `<float>` | `<float>` |
| ... | ... | ... |

#### Output
### Output

When the input is fed to the `append_dynamics` function, the output extends the original data frame with all the extra dynamical information available in the package:

Expand All @@ -105,7 +105,7 @@ When the input is fed to the `append_dynamics` function, the output extends the
| $t_3$ | `<float>` | `<float>` | | `<vector>` | `<vector>` | `<float>` | `<vector>` |
| ... | ... | ... | | ... | ... | ... | ... |


## Detailed tutorial
### Movement and how to store it

This is a package for studying movement. So we need a way of coding
Expand Down

0 comments on commit 073b0d5

Please sign in to comment.