Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up docs #91

Merged
merged 1 commit into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions src/correlation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ use crate::statistic::distribution::{cov_stdev, rank, RankMode};
/// use traquer::correlation;
///
/// correlation::pcc(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 6).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -91,8 +91,8 @@ pub fn pcc<'a, T: ToPrimitive>(
/// use traquer::correlation;
///
/// correlation::rsq(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 6).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -124,8 +124,8 @@ pub fn rsq<'a, T: ToPrimitive>(
/// use traquer::correlation;
///
/// correlation::beta(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 2).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -189,8 +189,8 @@ pub fn beta<'a, T: ToPrimitive>(
/// use traquer::correlation;
///
/// correlation::perf(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 2).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -227,8 +227,8 @@ pub fn perf<'a, T: ToPrimitive>(
/// use traquer::correlation;
///
/// correlation::rsc(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// ).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -262,8 +262,8 @@ pub fn rsc<'a, T: ToPrimitive>(
/// use traquer::correlation;
///
/// correlation::srcc(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 6).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -308,8 +308,8 @@ pub fn srcc<'a, T: ToPrimitive + PartialOrd + Clone>(
/// use traquer::correlation;
///
/// correlation::krcc(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 6).collect::<Vec<f64>>();
///
/// ```
Expand Down Expand Up @@ -370,8 +370,8 @@ pub fn krcc<'a, T: ToPrimitive>(
/// use traquer::correlation;
///
/// correlation::hoeffd(
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
/// 6).collect::<Vec<f64>>();
///
/// ```
Expand Down
Loading